1. Intro
  2. From domains
    1. Get all from domains
    2. Get specific from domain
    3. Create from domain
    4. Verify from domain
    5. Delete from domain
    6. From domain object definition
  3. From addresses
    1. Get all from addresses
    2. Get specific from address
    3. Create from address
    4. Update from address
    5. Delete from address
    6. From address object definitions
  4. Address lists
  5. Templates
    1. Get all templates
    2. Get specific template
    3. Create template
    4. Update template
    5. Delete template
    6. Template object definitions
  6. Campaigns
    1. Get all campaigns
    2. Get specific campaign
    3. Create campaign
    4. Update campaign
    5. Delete campaign
    6. Clone campaign
    7. Get statistics
    8. Get clicks
    9. Get statistics details
    10. How to use triggered campaigns
    11. Campaign object definitions
  7. Mailings
    1. Get all mailings
    2. Get specific mailing
    3. Create mailing
    4. Update mailing
    5. Delete mailing
    6. Get statistics
    7. How to use merge fields
    8. Mailing object definitions
  8. Mails
    1. Create mail
    2. Create triggered mail
    3. Mail object definitions
  9. Unsubscriptions
    1. Get all unsubscriptions
    2. Create unsubscription
    3. Delete unsubscription
    4. Unsubscription object definition
  10. Campaign tags
    1. Get all campaign tags
    2. Get specific campaign tag
    3. Create campaign tag
    4. Update campaign tag
    5. Delete campaign tag
    6. Add campaign tag to campaign
    7. Delete campaign tag from campaign
    8. Campaign tag object
  11. Webhooks
    1. Get webhook
    2. Create or update webhook
    3. Delete webhook
    4. Webhook object definition
    5. How to implement the webhook

Create template

Create a template. This method is mainly useful for duplicating existing templates. To edit your template in our web app, the template json needs to be correct because our editor needs this json. So creating new templates without json is possible but not very useful.

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

POST Parameters

Name In Description Required Type Example
AccountID Path The account guid True Guid A8C062E4-ECFD-48D0-89B1-A37D2622B7A9
Body Body The template to create True Json object { "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": "Subscribe", "Link": "[[ SpecialLink.Subscribe ]]", "Mapping": "SpecialLink.Subscribe", "Tag" : null }, { "Type": "system", "Label": "View in browser", "Link": "[[ SpecialLink.ViewInBrowser ]]", "Mapping": "SpecialLink.ViewInBrowser", "Tag" : null } ] }, "TemplateEditorType": 2 }
X-CM-PRODUCTTOKEN Header Your product token True Guid C24A5029-37DD-4161-9728-F80D8639588E

Responses

Http status Description Example
201 Template created { "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": "Subscribe", "Link": "[[ SpecialLink.Subscribe ]]", "Mapping": "SpecialLink.Subscribe", "Tag" : null }, { "Type": "system", "Label": "View in browser", "Link": "[[ SpecialLink.ViewInBrowser ]]", "Mapping": "SpecialLink.ViewInBrowser", "Tag" : null } ] }, "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 }
400 Bad request

Try it out