Agendize Developers API

Marketing Emails API

Marketing Email Templates

On September 1st, 2024 we released the version 2.3 of the Marketing Message Template API. This new version includes performance improvements and a better respect of HTTP protocol for RestFull APIs. If you are currently using the v2.0 of the Online Scheduling API, we encourage you to update to the newer version. If needed, the previous version's documentation is still available here.

Resource representation

{ "id": {string}, "name": {string}, "html": {string}, "subject": {string}, "messageType": {string} }
Parameter name Value Description
id string Identifier of the message template.
name string Name of the message template. Writable. Max length: 127
html string HTML body of the message template. Writable. Max length: 2MB
subject string Subject of the message template. Writable. Max length: 127
messageType string Type of the message template. Values: "marketing", "transactional". Default: "marketing".

Delete

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.3/messages/emails/templates/{templateId}

Parameters

Parameter name Value Description
Path parameters
templateId string Message Template identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

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

Request

HTTP Request

GET https://api.agendize.com/api/2.3/messages/emails/templates/{templateId}

Parameters

Parameter name Value Description
Path parameters
templateId string Message Template identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Message Template in the response body.

List

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

Request

HTTP Request

GET https://api.agendize.com/api/2.3/messages/emails/templates

Request body

Do not supply a request body with this method.

Response

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

{ items: [Message Template Resource] }

Insert

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

Request

HTTP Request

POST https://api.agendize.com/api/2.3/messages/emails/templates

Request body

In the request body, supply a Message Template Resource with the following properties:

Parameter name Value Description
Required Properties
name string Name of the message template.
html string HTML body of the message template.
subject string Subject of the client.
Optional Properties
messageType string Type of the message template. Values: "marketing", "transactional". Default: "marketing".

Response

If successful, this method returns a Message Template in the response body.

Update

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

Request

HTTP Request

PUT https://api.agendize.com/api/2.3/messages/emails/templates/{templateId}

Parameters

Parameter name Value Description
Path parameters
templateId string Template identifier.

Request body

In the request body, supply a Message Template Resource with the following properties:

Parameter name Value Description
Optional Properties
name string Name of the message template.
html string HTML body of the message template.
subject string Subject of the client.
messageType string Type of the message template. Values: "marketing", "transactional". Default: "marketing".

Response

If successful, this method returns a Message Template Resource in the response body.

Agendize | Support | Status

Last update: Oct 15, 2024 - Copyright © 2024 Agendize. All rights reserved.