Agendize Developers API

Agendize Actions API

Share a link

Share a web link by email.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/api/2.3/actions/shareALink

Request body

In the request body, supply a request resource:

{ "link": { "url": {string} }, "recipients": [ { "id": {string}, "externalId": {string}, "emailAddress": {string}, } ] }
Parameter name Value Description
Required Properties
link object Link to the web page.
link.url string Web page URL.
recipients[] list Array of recipient. Choose only a property between "id", "externalId" and "emailAddress"
recipients[].id string Identifier of the contact.
recipients[].externalId string External identifier of the contact.
recipients[].emailAddress string Email address of the contact.

Response

If successful, this method returns a response content in the response body:

{ "items": [ { "sent": { "dateTime": {string}, "timeZone": {string }, "recipient": { "id": {string}, "firstName": {string}, "lastName": {string}, "emailAddress": {string} } } ] }