POST /api/v2/shareable_links
Create shareable link

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Params

Param name	Description
expiry_date required	Expiry date Validations: Must be a String
limit required	Limit Validations: Must be a Integer
payload required	Validations: Must be a Hash
payload[media_id] required	Media ID Validations: Must be a Integer
payload[filename] required	Filename Validations: Must be a String

Examples

// Successful request
POST /api/v2/shareable_links
{
  "expiry_date": "2023-11-28",
  "limit": 5,
  "payload": {
    "asset_id": "b5Iix0ul_b2bTnT23Jo-",
    "filename": "test_file",
    "media_id": 4
  }
}
200
{
  "id": 4,
  "url": "https://test-account-5.devmediapocket.fi/api/v2/shareable_links/71f88dbe-13a9-485e-be99-0ac68bf849cc",
  "filename": "test_file"
}

// With invalid parameters
POST /api/v2/shareable_links
{
  "expiry_date": "2023-11-28",
  "limit": 5,
  "payload": {
    "asset_id": "invalid_id",
    "filename": "test_file",
    "media_id": 5
  }
}
400
{
  "error": "asset not found"
}

Errors

Code	Description
401	Unauthorized
404	Not found
500	Internal Server Error
422	Missing parameters