Dotdigital

Dotdigital Cpaas API

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

GitHub OpenAPI

Operations 73

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

Documentation

📖
Documentation
https://marketing.developer.dotdigital.com/docs/getting-started-with-the-api
📖
APIReference
https://marketing.developer.dotdigital.com/reference/
📖
Documentation
https://marketing.developer.dotdigital.com/docs/api-end-points
📖
APIReference
https://marketing.developer.dotdigital.com/reference/unified-contacts
📖
Documentation
https://marketing.developer.dotdigital.com/reference/omnichannel-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dotdigital/refs/heads/main/openapi/dotdigital-cpaas-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/dotdigital-cpaas-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

dotdigital-cpaas-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Dotdigital Cpaas API
  version: '1.0'
  description: 'Operations tagged Cpaas across 12 of this provider''s published API definitions: chat-api.json, chat-config-api.json, chat-message-api.json, chat-presence-api.json, content-api.json, conversation-api.json, conversation-message-api.json, dotdigital-message-history-openapi.yml, dotdigital-message-rules-openapi.yml, dotdigital-profile-openapi.yml, dotdigital-session-openapi.yml, dotdigital-templates-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{region}-api.dotdigital.com
  variables:
    region:
      description: The Dotdigital region id your account belongs to
      enum:
      - r1
      - r2
      - r3
      default: r1
- url: http://{region}-api.dotdigital.com/v2
  variables:
    region:
      description: The Dotdigital region id your account belongs to
      enum:
      - r1
      - r2
      - r3
      default: r1
security:
- basicAuth: []
tags:


# --- truncated at 32 KB (123 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dotdigital/refs/heads/main/openapi/dotdigital-cpaas-api-openapi.yml