Skip to main content

Get all templates

Retrieve all templates available for your account.

GET https://api.cm.com/bulkemail/v1.0/accounts/{accountID}/templates

GET Parameters​

NameInDescriptionRequiredTypeExample
AccountIDPathThe account guidTrueGuidA8C062E4-ECFD-48D0-89B1-A37D2622B7A9
SkipQueryThe amount of from address to skipFalse (default 0)Int0
TakeQueryThe amount of from address to takeFalse (default 1000)Int1000
IncludeHtmlBodyQueryWhether to include the html body in the responseFalse (default True)BoolTrue
IncludeTextBodyQueryWhether to include the text body in the responseFalse (default True)BoolTrue
IncludeJsonQueryWhether to include the template json in the responseFalse (default True)BoolTrue
FilterQueryThe name to filter onFalseStringMy awesome template
X-CM-PRODUCTTOKENHeaderYour product tokenTrueGuidC24A5029-37DD-4161-9728-F80D8639588E

Responses​

Http statusDescription
200Successful operation
400Bad request
Example response
[
{
"ID": "6c176f77-a2cd-45bf-b318-ec6150fee028",
"AccountID": "a65b6ba1-7b13-4cff-aaf6-c736c977c1d4",
"Name": "Demo",
"Description": "",
"HtmlBody": "Omitted for clarity",
"TextBody": "Follow [[ SpecialLink.ViewInBrowser ]] to view the message in your browser",
"Json": "Omitted for clarity",
"MergeFields": {
"MergeTags": [
{
"Name": "Sender.EmailAddress",
"Value": "{{ Sender.EmailAddress }}",
"Mapping": "Sender.EmailAddress"
},
{
"Name": "Recipient.EmailAddress",
"Value": "{{ Recipient.EmailAddress }}",
"Mapping": "Recipient.EmailAddress"
}
],
"SpecialLinks": [
{
"Type": "system",
"Label": "Unsubscribe",
"Link": "[[ SpecialLink.Unsubscribe ]]",
"Mapping": "SpecialLink.Unsubscribe",
"Tag": null
},
{
"Type": "system",
"Label": "View in browser",
"Link": "[[ SpecialLink.ViewInBrowser ]]",
"Mapping": "SpecialLink.ViewInBrowser",
"Tag": null
}
]
},
"TemplateEditorType": 2,
"CreatedOn": "2017-08-04T14:16:26.283",
"CreatedOnUtc": "2017-08-04T13:16:26.283Z",
"ModifiedOn": "2017-08-04T14:16:26.283",
"ModifiedOnUtc": "2017-08-04T13:16:26.283Z",
"DeletedOn": null,
"DeletedOnUtc": null
}
]