Marketing Emails API

Messages


Resource representation

{ "templateId": {string}, "subject": {string}, "html": {string}, "company": { "id": {string} }, "replyTo": { "emailAddress": {string} }, "recipients": [ { "id": {string} } ] }
Parameter name Value Description
recipient list List of recipients.
templateId string The id of the email template to use.
subject string The subject of the email. Only required if you don't use an email template. Writable. Max length: 127
html string The content of the email. Only required if you don't use an email template. Writable. Max length: 65535
company object Company for scheduling emails.
company.id string The id of the company.
replyTo object The reply-to address.
emailAddress string The email address of the reply-to.
recipients[] list List of recipient from client list.
recipients[].id string The id of the client.

Send

Send E-Mailing.

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/emails/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.
subject string The subject of the email. Only required if you don't use an email template
html string The content of the email. Only required if you don't use an email template

Response

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

{ items: [ { "id": {string}, "recipientId": {string}, "sentDate": { "dateTime": {string}, "timeZone": {string} } } ] }
Parameter name Value Description
id list Sent message identifier.
recipientId string Client identifier. You can use this identifier value with the Client API
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.