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
Dotdigital

Dotdigital Omnichannel API

The Omnichannel API API from Dotdigital — 6 operation(s) for omnichannel api.

Documentation Provider Profile APIs.io OpenAPI GitHub

Dotdigital Omnichannel API is one of 63 APIs that Dotdigital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 8 operations across 6 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.3.1.

Requests are made against a single base URL, https://{region}-api.dotdigital.com.

8 operations 6 paths 28 schemas 1 DELETE1 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3.1
Base URL
https://r1-api.dotdigital.com/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Dotdigital Omnichannel API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 1 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Omnichannel API 8
POST
/cpaas/messages/{messageId}/statuses/{status}
Posts a status for a message
2 params body → 200400404
GET
/cpaas/messages/{messageId}
Retrieves the current state of a specific message.
1 param → 200404
DELETE
/cpaas/messages/{messageId}
Deletes a Message
1 param → 204404409
PATCH
/cpaas/messages/{messageId}
Patches a Message
1 param body → 202400404409
POST
/cpaas/messages
Send a new message
body → 201400
POST
/cpaas/messages/batch
Send a batch of new messages
body → 202400
POST
/cpaas/messages/inbounds
Posts an inbound message
body → 201400
POST
/cpaas/messages/inbounds/{inboundMessageId}/statuses/{status}
Posts a status for an inbound
2 params body → 200400404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Message (19 properties), InboundMessage (17 properties), MessageBase (13 properties), channelOptions (7 properties). Each schema is shown below with its type and property counts.

inline_response_202
object
2 properties 2 required
MessagePart
object
Details of a single part that makes up a message
6 properties 1 required
channelOptions
object
Configuration switches for specific channels. If a channel has a customBody as well as values in here, it will return a validation failure. Profile data can be…
7 properties
to
object
Set of identifiers for the message recipient.
4 properties
InboundMessageStatus
object
2 properties 1 required
Message_overrides_appMessaging
object
Overrides for the app messaging send.
1 property
customBody
object
Custom body for specific channels. All values specified will be copied onto the payload at the point of sending. Profile data can be substituted anywhere by us…
7 properties
channelOptions_nativePush_deepLink
object
Deep link details
3 properties
channelOptions_sms_unicodeConversion
object
Unicode conversion settings
2 properties
MessageStatus
object
4 properties 1 required
MessagePatchBase
object
2 properties 1 required
channelOptions_whatsApp
object
Options for the WhatsApp channel
2 properties
channelOptions_fbMessenger
object
Options for the Facebook Messenger channel
2 properties
channelOptions_nativePush_data
object
Additional data passed to push message
3 properties
channelOptions_nativePush_deepLink_fcm
object
1 property 1 required
Message_overrides
object
Details of any overrides allowed for the message send on any of the channels
1 property
channelOptions_rcs
object
Options for the RCS channel
1 property
channelOptions_sms_unicodeConversion_customReplacements
object
2 properties
channelOptions_mms
object
Options for the MMS channel
3 properties
channelOptions_appMessaging
object
Options for the app messaging send.
1 property
channelOptions_appMessaging_from
object
Set of identifiers for the message sender.
3 properties
InboundMessage_correlation
object
Data relating to the outbound this inbound is in reply to
2 properties 1 required
MessageBase
object
13 properties 2 required
InboundMessage
object
17 properties 2 required
Message
object
19 properties
channelOptions_sms
object
Options for the SMS channel
3 properties
InboundMessage_channelData
object
1 property
channelOptions_nativePush
object
Options for the native push channel
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dotdigital-omnichannel-api-api-openapi.yml Raw ↑

Other APIs Dotdigital publishes across the network.

Dotdigital Marketing Developer Hub MCP Server
AE Profile APIs.io
Dotdigital Accounts and Utilities API
AE Profile APIs.io
Dotdigital API Account API
AE Profile APIs.io
Dotdigital API Address Book API
AE Profile APIs.io
Dotdigital API Campaign API
AE Profile APIs.io
Dotdigital API Campaign From Address API
AE Profile APIs.io
Dotdigital API Campaign Reporting API
AE Profile APIs.io
Dotdigital API Campaign Send API
AE Profile APIs.io
Dotdigital API Contact API
AE Profile APIs.io
Dotdigital API Contact Import API
AE Profile APIs.io
Dotdigital API Data Field API
AE Profile APIs.io
Dotdigital API Document API
AE Profile APIs.io
#Omnichannel API
← Back to D APIs
API Details
ID
dotdigital:dotdigital-omnichannel-api-api
Base URL
https://r1-api.dotdigital.com/v2
Docs
https://marketing.developer.dotdigital.com/docs/getting-started-with-the-api
Provider
Dotdigital
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=dotdigital-omnichannel-api-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/dotdigital-omnichannel-api-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 Dotdigital Omnichannel 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.