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 Cpaas API

The Cpaas API from Dotdigital — 41 operation(s) for cpaas.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 73 operations across 41 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://{region}-api.dotdigital.com, http://{region}-api.dotdigital.com/v2.

73 operations 41 paths 67 schemas 17 DELETE25 GET2 PATCH15 POST14 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 73

Across 41 paths, the API surfaces 73 operations — 17 DELETE, 25 GET, 2 PATCH, 15 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.

Cpaas 73
GET
/cpaas/chat/config
Retrieves the chat configuration for an apiSpace
→ 200404
GET
/cpaas/chat/config/teams/{teamId}
Retrieves the members of a team
1 param → 200404
DELETE
/cpaas/chat/config/teams/{teamId}
Removes the config for a team
2 params → 200404412
PUT
/cpaas/chat/config/teams/{teamId}/appMessaging
Update the App Messaging config for a team
2 params body → 200404412
DELETE
/cpaas/chat/config/teams/{teamId}/appMessaging
Removes the App Messaging config for a team
2 params → 200404412
PUT
/cpaas/chat/config/teams/{teamId}/settings
Update general settings for a team
2 params body → 200404412
DELETE
/cpaas/chat/config/teams/{teamId}/settings
Removes the settings for a team
2 params → 200404412
GET
/cpaas/chats/{chatId}/events
Retrieves a chat's events
3 params → 200
GET
/cpaas/chats/{chatId}/messages
Retrieves a chat's messages from an point (event) in time and works backwards
3 params → 200
POST
/cpaas/chats/{chatId}/messages
Sends a message to chat
1 param body → 200
POST
/cpaas/chats/{chatId}/messages/statusupdates
Posts message updates back
1 param body → 200
GET
/cpaas/chats/{chatId}
Retrieves a chat
2 params → 200404
PUT
/cpaas/chats/{chatId}
Updates a chat
2 params body → 200400404409412
DELETE
/cpaas/chats/{chatId}
Deletes a chat
2 params → 204404409412
PUT
/cpaas/chats/{chatId}/assign
Assigns a chat
2 params body → 200400404409412
PUT
/cpaas/chats/{chatId}/close
Closes a chat
2 params body → 200400404409412
PUT
/cpaas/chats/{chatId}/channel
Changes the channel for an existing chat
2 params body → 200400404409412
POST
/cpaas/chats/{chatId}/form
Sends a form to a chat
1 param body → 200400404
GET
/cpaas/chats
Retrieves a list of chats
5 params → 200
POST
/cpaas/chats
Creates a new chat
body → 201400409
POST
/cpaas/chats/{chatId}/typing
Indicates that the caller is typing in this chat
1 param → 204
DELETE
/cpaas/chats/{chatId}/typing
Indicates that the caller has stopped typing in this chat
1 param → 204
GET
/cpaas/chats/{chatId}/participants
Retrieves the chat participants
1 param → 200404
GET
/cpaas/presence
Retrieves the presence for a list of agent's profileIds
2 params → 200
GET
/cpaas/presence/appmessaging
Retrieves the presence for a list of user's profileIds
1 param → 200
POST
/cpaas/content
Upload a file
body → 200404
GET
/cpaas/content/{fileId}
Retrieve a file
1 param → 200404
DELETE
/cpaas/content/{fileId}
Delete a file
1 param → 200404
GET
/cpaas/conversations/{conversationId}/events
Retrieves a conversation's events
3 params → 200
GET
/cpaas/conversations/{conversationId}/messages
Retrieves a conversation's messages from an point (event) in time and works backwards
3 params → 200
POST
/cpaas/conversations/{conversationId}/messages
Sends a message to conversation
1 param body → 200
POST
/cpaas/conversations/{conversationId}/messages/statusupdates
Posts message updates back
1 param body → 200
GET
/cpaas/conversations/{conversationId}
Retrieves a conversation
2 params → 200404
PUT
/cpaas/conversations/{conversationId}
Updates a conversation
2 params body → 200400404409412
DELETE
/cpaas/conversations/{conversationId}
Deletes a conversation
2 params → 204404409412
GET
/cpaas/conversations
Retrieves a list of conversations
3 params → 200
POST
/cpaas/conversations
Creates a new conversation
body → 201400409
POST
/cpaas/conversations/{conversationId}/typing
Indicates that the caller is typing in this conversation
1 param → 204
DELETE
/cpaas/conversations/{conversationId}/typing
Indicates that the caller has stopped typing in this conversation
1 param → 204
GET
/cpaas/conversations/{conversationId}/participants
Retrieves the conversation participants
1 param → 200404
POST
/cpaas/conversations/{conversationId}/participants
Adds a list of participants to a conversation
1 param body → 201400404
DELETE
/cpaas/conversations/{conversationId}/participants
Deletes a list of participants from a conversation
2 params → 204404
GET
/cpaas/profiles/{profileId}/messages
Retrieves message history for the specified profile. Messages retrieved from the date spacified (default now), in descending time order.
5 params → 200
GET
/cpaas/automation/inboundrules
Retrieves a message rules configuration list
→ 200404
POST
/cpaas/automation/inboundrules
Create a message rule configuration
1 param body → 200404
GET
/cpaas/automation/inboundrules/{messageRulesId}
Retrieves single message rule configuration
1 param → 200404
PUT
/cpaas/automation/inboundrules/{messageRulesId}
Update single message rule configuration
2 params body → 200404
DELETE
/cpaas/automation/inboundrules/{messageRulesId}
Delete single message rule configuration
1 param → 204404
POST
/cpaas/profiles/export
Exports the result of a profile query in a formatted file for download
1 param body → 200
DELETE
/cpaas/profiles/bulk
Deletes the requested profiles
1 param → 200
PATCH
/cpaas/profiles/bulk
Creates or updates the supplied profiles with the supplied data
body → 200
GET
/cpaas/profiles/{id}
Retrieves a Profile
2 params → 200404
PUT
/cpaas/profiles/{id}
Updates or undeletes a Profile
2 params body → 200404409
DELETE
/cpaas/profiles/{id}
Deletes a Profile
2 params → 204404409
PATCH
/cpaas/profiles/{id}
Patches a Profile
3 params body → 200404409
PUT
/cpaas/profiles/{id}/optin
Set profile opt in for specified channels
1 param body → 200404
DELETE
/cpaas/profiles/{id}/optin
Set profile opt in for specified channels
2 params → 200404
PUT
/cpaas/profiles/{id}/rels/primary/{linkedId}
Creates a relationship where the linked profile is the primary and this profile is a child
2 params → 200404409
DELETE
/cpaas/profiles/{id}/rels/primary/{linkedId}
Deletes the profile's relationship to a primary profile
2 params → 200404409
PUT
/cpaas/profiles/{id}/rels/link/{linkedId}
Creates a relationship where this profile is the primary and the linked profile is a child
2 params → 200404409
DELETE
/cpaas/profiles/{id}/rels/link/{linkedId}
Deletes the primary profile's relationship to a linked Profile
2 params → 200404409
GET
/cpaas/profiles
Query profiles
9 params → 200
POST
/cpaas/profiles
Creates a new Profile
body → 201409
GET
/cpaas/profiles/optin
Gets default profiles opt in/out options for each channel in channel service
→ 200
PUT
/cpaas/profiles/optin
Set default profiles opt in/out options for each channel in channel service
→ 200
GET
/cpaas/sessions/tokens/anon
Gets a token that can be used to start an anonymous session
2 params → 200404
GET
/cpaas/sessions/{id}
Retrieves details about a session
1 param → 200404
DELETE
/cpaas/sessions/{id}
Ends a session, revoking access to services.
1 param → 204404409
GET
/cpaas/templates
Retrieves a list of all available templates
→ 200404
POST
/cpaas/templates
Create a template
body → 201404
GET
/cpaas/templates/{templateId}
Retrieves a template
2 params → 200404
PUT
/cpaas/templates/{templateId}
Updates a template
2 params body → 200404412
DELETE
/cpaas/templates/{templateId}
Deletes a template
2 params → 204404412

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are Chat (13 properties), ConversationQueryResult (12 properties), sessionFull (12 properties), Conversation (10 properties). Each schema is shown below with its type and property counts.

appMessagingConfig
object
The App Messaging configuration for the team
2 properties 1 required
configFull
object
All chat configuration for the apiSpace.
5 properties
settings
object
The general settings for the team
6 properties
workingHoursSingle
object
The working hours configuration for the team
3 properties 3 required
configSingle
object
3 properties
teamMembers
object
The members of the chat team
7 properties
MessageAlertPlatforms
object
The platform specific details for the alert. If specified, these are set verbatim and alert.title / alert.body values are ignored
2 properties
MessageAlertApns
object
The APNS details for the alert
4 properties
MessagePostResult
object
The id of the message sent event recorded
2 properties 1 required
MessagePost_from
object
Set of identifiers for the message sender.
2 properties 1 required
MessageAlert
object
Details of the alert to be displayed on receipt of the message
3 properties
MessageContext
object
Platform metadata relating to the message
5 properties
MessageContextFrom
object
Details of the sender of a message
2 properties
MessageEvent
object
An event relating to a message
2 properties
MessageStatusUpdate
object
3 properties 3 required
MessageComplete
object
Details of a message sent to a chat
6 properties
MessagePart
object
Details of a single part that makes up the message
5 properties
MessageResult
object
A list of chat messages
4 properties
MessageAlertFcmNotification
object
Details of the notification to display
3 properties
MessageAlertFcm
object
The FCM details for the alert
3 properties
MessagePost
object
Details of a message to post to the chat
6 properties 1 required
chatId_form_body
object
1 property
ChatContext
object
1 property
Chat
object
13 properties
AssignmentDetails
object
2 properties 1 required
Participant
object
2 properties 1 required
chatId_channel_body
object
1 property
chatId_close_body
object
1 property
ChatCreate
object
6 properties 3 required
ChatUpdate
object
2 properties 1 required
Presence
array
ProfilePresence
object
5 properties
AppMsgPresence
array
AppMsgProfilePresence
object
4 properties
cpaas_content_body
object
3 properties 3 required
UploadedFile
object
10 properties
MessagePostResult_2
object
The id of the message sent event recorded
2 properties 1 required
MessageContext_2
object
Platform metadata relating to the message
6 properties
MessageContextFrom_2
object
Details of the sender of a message
3 properties
MessageComplete_2
object
Details of a message sent to a conversation
6 properties
MessageResult_2
object
A list of conversation messages
4 properties
MessagePost_2
object
Details of a message to post to the conversation
5 properties 1 required
Participant_2
object
2 properties 1 required
ConversationUpdate
object
3 properties 2 required
Privileges
object
3 properties 3 required
ConversationCreate
object
7 properties 4 required
Conversation
object
10 properties
ConversationQueryResult
object
12 properties
Roles
object
Describes the roles belonging to the conversation
2 properties 2 required
MessageHistoryEntry_message
object
The message details.
3 properties
MessageHistoryEntry
object
7 properties 1 required
InboundRuleConfiguration_actionData
object
Defines options for picked action
3 properties
ProfileChange
object
Single profile change
2 properties
MessagePart_2
object
Details of a single part that makes up a message
5 properties 1 required
InboundRuleConfiguration
object
6 properties
ProfileCreate
object
2 properties
ProfileExportOptions
object
4 properties 1 required
ProfileFull
object
7 properties 1 required
id_optin_body
object
1 property
sessionPushConfig
object
2 properties
sessionFull
object
12 properties 11 required
sessionPushConfigFcm
object
The FCM push configuration for the session
2 properties 2 required
sessionPushConfigApns
object
The APNS push configuration for the session
3 properties 3 required
templateCreate
object
4 properties 2 required
templateFull
object
8 properties
messagePart
object
templateUpdate
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dotdigital-cpaas-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
#CPaaS
← Back to D APIs
API Details
ID
dotdigital:dotdigital-cpaas-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-cpaas-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/dotdigital-cpaas-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 Cpaas 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.