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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Cordial

Cordial batch messages API

The batch messages API from Cordial — 18 operation(s) for batch messages.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 24 operations across 18 paths, and defines 26 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/.

24 operations 18 paths 26 schemas 2 DELETE7 GET2 POST13 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
View terms
Resource Areas
1

Authentication & Security 1

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

  • basicAuth — HTTP Basic Authentication. Works over HTTPS

Paths & Operations 24

Across 18 paths, the API surfaces 24 operations — 2 DELETE, 7 GET, 2 POST, 13 PUT. Each is listed below with its method, path, parameters, and response codes.

batch messages 24
POST
/v1/batchmessages
Create a batch message
addBatch body → 201422
GET
/v1/batchmessages
Get batch messages
getBatch 16 params → 201404
PUT
/v1/batchmessages/{id}
Update an existing message
updateBatch 1 param body → 201400
GET
/v1/batchmessages/{id}
GET single message by msID
getSingleBatch 1 param → 201404
DELETE
/v1/batchmessages/{id}
Delete a single contact
deleteSingleBatch 1 param → 201404
PUT
/v1/batchmessages/{id}/send
Send Manual Messagesend
sendSingleBatch 1 param → 201404400
PUT
/v1/batchmessages/{id}/sendtest
Send a test batch message
sendTestSingleBatch 1 param body → 201404
GET
/v1/batchmessages/{id}/renderedwip/{contactID}
Render preview of a batch message
renderPreviewSingleBatch 4 params → 201404
PUT
/v1/batchmessages/{id}/pause
Pause a batch message sending
pauseSingleBatch 1 param → 201404
PUT
/v1/batchmessages/{id}/cancel
Cancel a batch message sending
cancelSingleBatch 1 param → 201404
PUT
/v1/batchmessages/{id}/resume
Resume a batch message sending
resumeSingleBatch 1 param → 201404
POST
/v2/batchmessages
Create a batch message
addBatch body → 201422
GET
/v2/batchmessages
Get batch messages
getBatch 16 params → 201404
PUT
/v2/batchmessages/{id}
Update a batch message draft
updateBatch 1 param body → 201422404
GET
/v2/batchmessages/{id}
Get a single batch message
getSingleBatch 1 param → 201404
DELETE
/v2/batchmessages/{id}
Delete a batch message
deleteSingleBatch 1 param → 200404
PUT
/v2/batchmessages/{id}/send
Send or schedule a batch message
sendSingleBatch 1 param → 201422404
PUT
/v2/batchmessages/{id}/sendtest
Send a test batch message
sendTestSingleBatch 1 param body → 201422404
GET
/v2/batchmessages/{id}/experimentperformance
Get experiment performance for single batch message
geBatchExperimentPerformance 1 param → 200404
GET
/v2/batchmessages/{id}/renderedwip/{contactID}
Render preview of a batch message
renderPreviewSingleBatch 4 params → 201404422
PUT
/v2/batchmessages/{id}/pause
Pause batch message sending
pauseSingleBatch 1 param → 201404
PUT
/v2/batchmessages/{id}/cancel
Cancel batch message sending
cancelSingleBatch 1 param → 201404
PUT
/v2/batchmessages/{id}/resume
Resume batch message sending
resumeSingleBatch 1 param → 201404
PUT
/v2/batchmessages/{id}/unschedule
Unschedule a batch message
unscheduleBatch 1 param → 201404

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are MessageSendBatchPost_2 (17 properties), ExperimentStats (14 properties), MessageSendBatchPost (14 properties), MessageSendBatch_2 (12 properties). Each schema is shown below with its type and property counts.

MessageSendBatch_2
object
12 properties 2 required
BatchSendMessageError
object
3 properties 3 required
ExperimentStats
object
14 properties
MessageSendBatchPost_2
object
17 properties 2 required
BatchMessageError
object
3 properties 3 required
ExperimentVariants
object
2 properties 2 required
AlertConditions
object
2 properties 4 required
ExperimentsStats
object
5 properties 5 required
Tests
object
2 properties 2 required
BatchMessageCreated
object
2 properties 2 required
SuccessOperation
object
1 property 1 required
RecordNotFound
object
3 properties 2 required
MessageSendBatchPost
object
14 properties 2 required
MessageSendBatch
object
9 properties 2 required
MessageBatch
object
2 properties 2 required
SuccessRenderMessage
object
3 properties 1 required
AlertResponse
object
8 properties
BatchRenderMessageError
object
3 properties 3 required
HeadersBatch
object
4 properties 4 required
HeadersBatch_2
object
4 properties 4 required
RecipientsTestBatch_2
object
1 property 1 required
BatchSendTestMessageError
object
3 properties 3 required
ContentBatch_2
object
1 property 1 required
RecipientsTestBatch
object
1 property 1 required
ContentBatch
object
1 property 1 required
Tests_2
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cordial-batch-messages-api-openapi.yml Raw ↑

Other APIs Cordial publishes across the network.

Cordial MCP Server
AE Profile APIs.io
Cordial account attributes API
AE Profile APIs.io
Cordial account lists API
AE Profile APIs.io
Cordial account monitor export API
AE Profile APIs.io
Cordial Alerts API
AE Profile APIs.io
Cordial analytics audiences API
AE Profile APIs.io
Cordial analytics messages API
AE Profile APIs.io
Cordial Audiencecount API
AE Profile APIs.io
Cordial automation templates API
AE Profile APIs.io
Cordial contact activities API
AE Profile APIs.io
Cordial contact activity exports API
AE Profile APIs.io
Cordial contact exports API
AE Profile APIs.io
#batch messages
← Back to C APIs
API Details
ID
cordial:cordial-batch-messages-api
Base URL
https://api.cordial.io/v2
Docs
https://developers.cordial.com/api
Provider
Cordial
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cordial-batch-messages-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cordial-batch-messages-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Cordial batch messages 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.