Marketing Emails API

Marketing Email Templates


Resource representation

{ "id": {string}, "name": {string}, "html": {string}, "subject": {string} }
Parameter name Value Description
id string Identifier of the message template.
name string Name of the message template.
html string HTML body of the message template.
subject string Subject of the message template.

Delete

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

Request

HTTP Request

DELETE http://az2.agendize.com/api/2.0/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 http://az2.agendize.com/api/2.0/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 http://az2.agendize.com/api/2.0/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:


Insert

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

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/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.

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 http://az2.agendize.com/api/2.0/messages/emails/templates/{templateId}

Parameters

Parameter name Value Description
Path parameters
templateId string Template identifier.

Request body

In the request body, supply a Client 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.

Response

If successful, this method returns a Client resource in the response body.