Agendize Platform API

Account Email Templates


Resource representation

{ "action": {string}, "name": {string}, "languages": { {string}: { "id": {string}, "language": {string}, "subject": {string}, "html": {string} } } "default": {boolean} }
Parameter name Value Description
action string Type of action. Values: "signupRight", "newRight", "formFilledAccount", "formFilledClient", "report", "linkSharing".
name string Name of the message template.
languages object Languages of the message template. Values: "en", "fr", "de", "es", "pt", "it".
languages[language].id string Identifier of message template.
languages[language].language string Language of message template.
languages[language].subject string Subject of the message template.
languages[language].html string HTML body of the message template.
default boolean If the content of the message template is a default message template. Read-only

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/account/templates/emails/{action}

Parameters

Parameter name Value Description
Path parameters
action string Action of the message template.

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/account/templates/emails/{action}

Parameters

Parameter name Value Description
Path parameters
action string Action of the message template.
Optional query parameters
language string language for template details. Default value: "en".

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/account/templates/emails/

Parameters

Parameter name Value Description
Optional query parameters
withContent boolean Retrieves message templates content for each language.
language string language for template details. Default value: "en".

Request body

Do not supply a request body with this method.

Response

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


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/account/templates/emails/{action}

Parameters

Parameter name Value Description
Path parameters
action string Action of the message template.
Optional query parameters
language string language for template details. Default value: "en".

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.
languages object Languages of the message template. Values: "en", "fr", "de", "es", "pt", "it".
languages[language].id string Identifier of message template.
languages[language].language string Language of message template.
languages[language].subject string Subject of the message template.
languages[language].html string HTML body of the message template.

Response

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