POST /api/v2/shareable_links/share
Send shareable links by email

Headers

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

Params

Param name Description
message
optional

Message

Validations:

  • Must be a String
recipients
required

Array of email addresses

Validations:

  • Must be an array of any type
shareable_link_ids
optional

Array of shareable link IDs

Validations:

  • Must be an array of any type

Examples

// Successful request
POST /api/v2/shareable_links/share
{
  "message": "This is an optional test message",
  "recipients": [
    "test1@testmail.test",
    "test2@testmail.test"
  ],
  "shareable_link_ids": [
    2
  ]
}
200
{
  "message": "Shareable links sent"
}
// With invalid parameters
POST /api/v2/shareable_links/share
{
  "message": "This is an optional test message",
  "recipients": [
    "test1@testmail.test",
    "test2@testmail.test"
  ],
  "shareable_link_ids": [
    "invalid_id"
  ]
}
400
{
  "error": "No shareable links found"
}

Errors

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