v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Email Template

Get Email Template

Get an Email Template by Id or by Source Template Id.

get/communications/emails/templates/{email_template_id}

Path parameters

email_template_idinteger required

email template id

Query parameters

get_by_source_idboolean

Indicates if the template id provided is a source email template. If true, the email template will be retrieved by source Id. If False, template will be retreived by its Id.

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Response

List of segments with their basic data.

idinteger required

Email Template Id

namestring

Name

customer_idinteger

customer id

html_contentstring

html content

Example response

{
  "id": 1234567891234567,
  "customer_id": 1234567891234567,
  "attachments": [
    {
      "file_storage_id": 1234567891234567
    }
  ]
}