How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cordial automation templates API

The automation templates API from Cordial — 15 operation(s) for automation templates.

Cordial automation templates API is one of 25 APIs that Cordial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include automation templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 21 operations across 15 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.cordial.io/.

21 operations 15 paths 35 schemas 2 DELETE9 GET6 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.cordial.io/v2
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Cordial automation templates API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

  • basicAuth — HTTP Basic Authentication. Works over HTTPS

Paths & Operations 21

Across 15 paths, the API surfaces 21 operations — 2 DELETE, 9 GET, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

automation templates 21
GET
/v1/automationtemplates/{key}
Get a single automation template
gettemplate 2 params → 200404
PUT
/v1/automationtemplates/{key}
Update a single automation template
updateTemplate 1 param body → 200404
DELETE
/v1/automationtemplates/{key}
Delete an automation template
deleteTemplate 1 param → 200404
POST
/v1/automationtemplates
Add a new automation template
addTemplate body → 200422
GET
/v1/automationtemplates
Get automation templates
getTemplates 12 params → 200
POST
/v1/automationtemplates/{key}/send
Send a batch message from an automation template
sentMessage 1 param body → 200404
POST
/v1/automationtemplates/{key}/senddraft
Send a draft message of an automation template
sentDraftMessage 1 param body → 200422
PUT
/v1/automationtemplates/{key}/publish
Publish a single automation template
publishTemplate 1 param → 200404422
GET
/v1/automationtemplates/{key}/renderdraft/{contactID}
Render draft content of a single automation template
renderPreviewAutomationtemplate 4 params → 201404
GET
/v1/automationtemplates/{key}/renderpublished/{contactID}
Render published content of a single automation template
renderPublishedAutomationtemplate 4 params → 201404
GET
/v2/automationtemplates/{key}
Get a single automation template
gettemplate 2 params → 200404
PUT
/v2/automationtemplates/{key}
Update an automation template
updateTemplate 1 param body → 200404
DELETE
/v2/automationtemplates/{key}
Delete an automation template
deleteTemplate 1 param → 200404
POST
/v2/automationtemplates
Add a new automation template
addTemplate body → 200422
GET
/v2/automationtemplates
Get automation templates
getTemplates 14 params → 200
POST
/v2/automationtemplates/{key}/send
Send a batch message from an automation template
sentMessage 1 param body → 200404
POST
/v2/automationtemplates/{key}/senddraft
Send a draft message of an automation template
sentDraftMessage 1 param body → 200422
PUT
/v2/automationtemplates/{key}/publish
Publish a single automation template
publishTemplate 1 param → 200404422
GET
/v2/automationtemplates/{key}/renderdraft/{contactID}
Render draft content of a single automation template
renderPreviewAutomationtemplate 4 params → 201404
GET
/v2/automationtemplates/{key}/renderpublished/{contactID}
Render published content of a single automation template
renderPublishedAutomationtemplate 4 params → 201404
GET
/v2/automationtemplates/{key}/experimentperformance
Get experiment performance for the published version of a single automation template
getAutomationTemplateExperimentPerformance 1 param → 200404

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are TemplateAuto_2 (14 properties), ExperimentStats (14 properties), TemplateShowAuto_2 (14 properties), TemplateAuto (11 properties). Each schema is shown below with its type and property counts.

TemplateAuto
object
11 properties 5 required
TemplateAuto_2
object
14 properties 5 required
extVarsAuto
object
Using 'extVars', any number of additional external variables may be added. These values are then available in the template. For example, if 'extVars': {'orderI…
1 property
ToAutoTest
object
2 properties 1 required
ContactAuto_2
object
1 property 1 required
AutomationTemplateRenderDraft
object
3 properties
AutomationTemplateSuccess
object
1 property 1 required
ExperimentStats
object
14 properties
ContactAuto
object
1 property 1 required
TemplateupdateAuto
object
5 properties 1 required
TemplateSendDraftResponse
object
1 property 1 required
ExperimentVariants
object
2 properties 2 required
AlertConditions
object
2 properties 4 required
TemplateSendResponse
object
3 properties 3 required
ExperimentsStats
object
5 properties 5 required
RecipientsAuto_2
object
2 properties 1 required
MessageAuto
object
2 properties 2 required
ContentAuto
object
1 property 1 required
contactIdentifier
object
3 properties 3 required
AutomationTemplateError
object
3 properties 3 required
RecordNotFound
object
3 properties 2 required
AutomationTemplateRenderPublish
object
2 properties
IdentifyBy
array
Specifies which identifier key in the request body should be used to look up the contact (e.g. cID, email, custID). Accepts a string or an array of strings in…
AlertResponse
object
8 properties
extVarsAuto_2
object
Using the "extVars" object, any number of external variables may be added. These values are then available in the template. For example, if 'extVars': {'orderI…
1 property
HeadersAuto
object
4 properties 3 required
RecipientsAuto
object
1 property 1 required
messagecontactsresponse
object
5 properties 3 required
TemplateShowAuto
object
9 properties 6 required
ToAuto
object
2 properties 1 required
TemplateupdateAuto_2
object
7 properties 1 required
AutomationTemplateCreated
object
2 properties 2 required
AutomationTemplateDelete
object
1 property
TemplateShowAuto_2
object
14 properties 6 required
RecipientsAutoTest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cordial-automation-templates-api-openapi.yml Raw ↑

Other APIs Cordial publishes across the network.

Cordial MCP Server
Cordial account attributes API
Cordial account lists API
Cordial account monitor export API
Cordial Alerts API
Cordial analytics audiences API
Cordial analytics messages API
Cordial Audiencecount API
Cordial batch messages API
Cordial contact activities API
Cordial contact activity exports API
Cordial contact exports API
Where this information came from

This is an independent, third-party profile of Cordial automation templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.