Marketing SMS API

Send SMS

Resource representation

{ "templateId": {string}, "text": {string}, "recipients": [ { "id": {string} } ] }

Parameter name	Value	Description
`recipients`	`list`	List of recipients. Writable.
`templateId`	`string`	The id of the email template to use. Writable.
`text`	`string`	The content of the SMS. Only required if you don't use an SMS template. Writable. Max length: 65535

Send

Send SMS.

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

Request

HTTP Request

POST https://api.agendize.com/api/2.0/messages/sms/send

Request body

In the request body, supply a list of Message resource with the following properties:

Parameter name	Value	Description
Required Properties
`recipient`	`list`	List of recipients.
Optional Properties
`templateId`	`string`	The id of the email template to use.
`text`	`string`	The content of the SMS. Only required if you don't use an SMS template

Response

If successful, this method returns a response body with the following structure with the following properties:

{ items: [ { "id": {string}, "recipient": [ { "id": {string}, "firstName": {string}, "lastName": {string}, "phoneNumber": {string}, "selfLink": {string} } ], "sentDate": { "dateTime": {string}, "timeZone": {string} } } ] }

Parameter name	Value	Description
`id`	`list`	Sent message identifier.
`phoneNumber`	`object`	Phone number of recipient.
`recipient`	`object`	The client details.
`client.id`	`string`	Identifier of the client.
`client.firstName`	`string`	First name of the client.
`client.lastName`	`string`	Last name of the client.
`phoneNumber`	`object`	Phone number of client.
`client.selfLink`	`string`	URL link to the client resource description.
`sentDate`	`object`	The sent date.
`sentDate.dateTime`	`string`	The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
`sentDate.timeZone`	`string`	The time zone. Possible values can be found here. The default value is the time zone of the company.