How can we help?

Overview

An automation template instance within the automation templates collection contains the essential information to define a template for an automated message. Templates include details for content, channel, message classification (transactional or promotional), subject line, from and reply address, and HTML. You can use a template one or more times.

Additional information

• Template key values must be unique. Therefore, it's important to consider a naming convention that will accommodate creating multiple templates over time. For example: sports_newsletter_Jan_2025_week1 is better than jan_newsletter.
• Cordial provides a default transport for sending communications; however it is possible to use an external provider if needed.
• By default, results data is aggregated on a daily interval. This can be optionally set to hourly if further granularity is needed.

Authentication

Cordial's core APIs use HTTPS Basic Authentication (BA). From within the Cordial platform, you can generate an encoded API key for your account and use it for authorization.

Methods, parameters, and examples

• POST/v2/automationtemplates
• GET/v2/automationtemplates
• GET/v2/automationtemplates/{key}
• PUT/v2/automationtemplates/{key}
• PUT/v2/automationtemplates/{key}/publish
• POST/v2/automationtemplates/{key}/senddraft
• POST/v2/automationtemplates/{key}/send
• DELETE/v2/automationtemplates/{key}
• GET/v2/automationtemplates/{key}/renderdraft/{contactID}
• GET/v2/automationtemplates/{key}/renderpublished/{contactID}

Required

Examples

Email

The following will create a new message automation template for a promotional email message.

{
  "key": "promo_01_20_2025",
  "name": "promo_01_20_2025",
  "channel": "email",
  "classification": "promotional",
  "baseAggregation": "hourly",
  "message": {
    "headers": {
      "subject": "One Day Only Sale",
      "fromEmail": "info@example.com",
      "replyEmail": "info@example.com",
      "fromDesc": "Promotions Team"
    },
    "content": {
      "text/html": "<div>Hello World</div>"
    }
  }
}

SMS

The following will create a new message automation template for a promotional SMS message.

{
  "key": "sms_cyber_promo",
  "baseAggregation": "daily",
  "channel": "sms",
  "classification": "promotional",
  "name": "Cyber Monday Deal",
  "tags": ["cyber_monday", "cm_promo"],
  "message": {
    "content": {
      "text": "SMS text message content"
    }
  }
}

GET/v2/automationtemplates

Parameters

DELETE/v2/automationtemplates/{key}

Error Responses

The Cordial API will return an error object with an errorKey and message if there is a problem with an API call. Below is a list of errors specific to the Automation Templates API endpoint, along with suggested modifications to resolve each error. If you receive an error from this API endpoint that is not listed in this table, it is likely recorded within the Global API Error Responses.