Get a list of all email templates on this platform
Use the following endpoint to get a list of all email templates created in your platform. There is no limit in the number of custom email templates you can create:
Endpoint | Purpose |
---|---|
GET {URI}/emailTemplates | Get a list of all Email Templates on this Platform. |
The following query parameters specify the format of data when you get a list of all email templates on this Platform. The response is paginated and defaults to the first page. The default is 25 templates per page if no page number is specified:
Query params | Data type | Description |
---|---|---|
elementsPerBlock | int32 | specify the number of elements in a block. |
page | int32 | specify the page number to return. |
See the payload example below for this endpoint. The default number of templates are shown here:
{
"page": {
"number": 0,
"elementsPerBlock": 25,
"resultCount": 25,
"totalCount": 99
},
"emailTemplates": [
{
"etid": "string",
"name": "string",
"fromName": "string",
"subject": "string",
"headerImage": "string",
"headerImageAltText": "string",
"accentColor": "string",
"messageBody": "string",
"closing": "string",
"customerServiceMessage": "string",
"accessControls": [
{
"type": "PLATFORM",
"identifier": "string"
}
],
"defaults": [
{
"type": "PLATFORM",
"identifier": "string"
}
]
}
]
}
The possible response codes for this endpoint are:
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
Updated 7 days ago