Agendize Developers API

Agendize Actions API

Share a link by text message

Share a web link by text message.

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/shareALinkByTextMessage

Request body

In the request body, supply a request resource:

{ "link": { "url": {string} }, "text": {string}, "recipients": [ { "id": {string}, "externalId": {string}, "mobilePhoneNumber": {string} } ] }
Parameter name Value Description
Required Properties
link object Link to the web page.
link.url string Web page URL.
text string Text of the message. Max length depends on the text message sending provider.
recipients[] list Array of recipient. Choose only a property between "id", "externalId" and "mobilePhoneNumber"
recipients[].id string Identifier of the contact.
recipients[].externalId string External identifier of the contact.
recipients[].mobilePhoneNumber string Mobile phone number of the contact. International format.

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}, "mobilePhoneNumber": {string} } } ] }