Engagement Cloud CPaaS APIs
Engagement Cloud API
Engagement Cloud API Reference
CPaaS API
CPaaS API Reference
Log in
Help centre
The dotdigital Engagement Cloud developer hub
Official dotdigital Engagement Cloud APIs documentation
Home
CPaaS API
CPaaS API Reference
Reference
Changelog
Community
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Tutorials
Home
CPaaS API
CPaaS API Reference
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Get Started
Overview
Quick Start
Channel Guides
SMS
Push / App Messaging
WhatsApp
Facebook Messenger
Twitter DM
Branch
Quick Starts
Send SMS Messages
C# - Send an SMS
Java - Send an SMS
NodeJS - Send an SMS
PHP - Send an SMS
Python - Send an SMS
Ruby - Send an SMS
Receiving Data using Webhooks
C# - Receiving Data
Java - Receiving Data
NodeJS - Receiving Data
PHP - Receiving Data
Python - Receiving Data
Ruby - Receiving Data
Using Facebook
C# - Using Facebook
Java - Using Facebook
NodeJS - Using Facebook
PHP - Using Facebook
Python - Using Facebook
Ruby - Using Facebook
Integration
Integrating Bots
Hosting
CPaaS API Hosting Overview
Firewalls
Get Started
Overview
Quick Start
Channel Guides
SMS
Push / App Messaging
WhatsApp
Facebook Messenger
Twitter DM
Branch
Quick Starts
Send SMS Messages
C# - Send an SMS
Java - Send an SMS
NodeJS - Send an SMS
PHP - Send an SMS
Python - Send an SMS
Ruby - Send an SMS
Receiving Data using Webhooks
C# - Receiving Data
Java - Receiving Data
NodeJS - Receiving Data
PHP - Receiving Data
Python - Receiving Data
Ruby - Receiving Data
Using Facebook
C# - Using Facebook
Java - Using Facebook
NodeJS - Using Facebook
PHP - Using Facebook
Python - Using Facebook
Ruby - Using Facebook
Integration
Integrating Bots
Hosting
CPaaS API Hosting Overview
Firewalls
The One API
The One API Overview
Calling the One API
Addressing your messages
Message sending across channels
Custom messages
Multi part messages
Templates
Channel selection
Additional options
Message send response
Inbound messages and receipts
Channels
SMS
Push
WhatsApp
Facebook
Twitter DM
App Messaging
Branch
Webhooks
Webhooks
One API - Message Events
One API - Profile Events
Facebook Events
App Messaging - Conversation Events
App Messaging - Message Events
App Messaging - Session Events
Chat - Events
Chat - Message Events
Chat - Presence Events
App Messaging
App Messaging Overview
Registering your app users
Creating a JWT for an app user
Android
Installing the SDK
Initialise
Start session
Client APIs
Listen to events
Push messages
Messaging service
Profile service
iOS
Installing the SDK
Initialise
Start session
Push messages
Listen to events
Client APIs
Profile services
Messaging services
JavaScript
Install the SDK
Initialise
Create conversation
Send message
Query conversations
Query conversation messages
Query events
Websocket events
Message status updates
Profile API
Typescript
Cordova
Push troubleshooting
Chat
Chat API
Web Chat Widget
Message "One" API
/cpaas/messages/{messageId}/statuses/{status}
post
Posts a status for a message
/cpaas/messages/{messageId}
get
Retrieves the current state of a specific message.
delete
Deletes a Message
patch
Patches a Message
/cpaas/messages
post
Send a new message
/cpaas/messages/batch
post
Send a batch of new messages
/cpaas/messages/inbounds
post
Posts an inbound message
/cpaas/messages/inbounds/{inboundMessageId}
get
Retrieves the current state of an inbound message.
delete
Deletes an inbound message
patch
Patches an inbound message
/cpaas/messages/mirror/{channel}
post
Creates a mirror of a batch of messages sent directly by a channel
/cpaas/messages/status/{channel}
post
Loads a batch of status changes for messages sent directly by a channel
/cpaas/messages/inbounds/{inboundMessageId}/statuses/{status}
post
Posts a status for an inbound
Message History API
/apispaces/{apiSpaceId}/profiles/{profileId}/messages
get
Retrieves message history for the specified profile. Messages retrieved from the date spacified (default now), in descending time order.
Templates API
/cpaas/templates
get
Retrieves a list of all available templates
post
Create a template
/cpaas/templates/{templateId}
get
Retrieves a template
put
Updates a template
delete
Deletes a template
Content API
/cpaas/content/{fileId}
get
Retrieve a file
Profile API
/cpaas/profiles/export
post
Exports the result of a profile query in a formatted file for download
/cpaas/profiles/bulk
patch
Creates or updates the supplied profiles with the supplied data
delete
Deletes the requested profiles
/cpaas/profiles/{id}
get
Retrieves a Profile
put
Updates or undeletes a Profile
patch
Patches a Profile
delete
Deletes a Profile
/cpaas/profiles/{id}/optin
put
Set profile opt in for specified channels
delete
Set profile opt in for specified channels
/cpaas/profiles/{id}/rels/primary/{linkedId}
put
Creates a relationship where the linked profile is the primary and this profile is a child
delete
Deletes the profile's relationship to a primary profile
/cpaas/profiles/{id}/rels/link/{linkedId}
put
Creates a relationship where this profile is the primary and the linked profile is a child
delete
Deletes the primary profile's relationship to a linked Profile
/cpaas/profiles
get
Query profiles
post
Creates a new Profile
/cpaas/profiles/import
post
Start the import process
/cpaas/profiles/optin
get
Gets default profiles opt in/out options for each channel in channel service
put
Set default profiles opt in/out options for each channel in channel service
/cpaas/profiles/import/{id}/duplicates
get
Get information about duplicated profiles
/cpaas/profiles/import/{id}/start
put
Start the import process
/cpaas/audiences/{id}
get
Retrieves an audience
put
Updates an audience
delete
Deletes an audience
/cpaas/audiences
get
Query audience
post
Creates a new audience
Conversation API
/cpaas/conversations/{conversationId}
get
Retrieves a conversation
put
Updates a conversation
delete
Deletes a conversation
/cpaas/conversations
post
Creates a new conversation
get
Retrieves a list of conversations
/cpaas/conversations/{conversationId}/typing
post
Indicates that the caller is typing in this conversation
delete
Indicates that the caller has stopped typing in this conversation
/cpaas/conversations/{conversationId}/participants
get
Retrieves the conversation participants
post
Adds a list of participants to a conversation
delete
Deletes a list of participants from a conversation
Conversation Message API
/cpaas/conversations/{conversationId}/events
get
Retrieves a conversation's events
/cpaas/conversations/{conversationId}/messages
post
Sends a message to conversation
get
Retrieves a conversation's messages from an point (event) in time and works backwards
/cpaas/conversations/{conversationId}/messages/statusupdates
post
Posts message updates back
Analytics API
/cpaas/analytics/conversationmessages
get
Retrieves conversation message analytics
/cpaas/analytics/messages
get
Retrieves message analytics
/cpaas/analytics/sessions
get
Retrieves session analytics
/cpaas/analytics/sms/tracking
get
Retrieves url tracking analytics
/cpaas/analytics/sms/verify
get
Retrieves sms verify analytics
/cpaas/analytics/sms/inbound
get
Retrieves inbound SMS analytics
/cpaas/analytics/sms/outbound
get
Retrieves outbound SMS analytics
Facebook API
post
Facebook Meta Data Service
Integrator API
get
Getting Message Statuses
get
Profile Schema Retrieval
Session API
/cpaas/sessions/tokens/anon
get
Gets a token that can be used to start an anonymous session
/cpaas/sessions/{id}
get
Retrieves details about a session
delete
Ends a session, revoking access to services.
Webhook API
/cpaas/webhooks
get
Retrieves a webhook configuration
post
Create a webhook configuration
/cpaas/webhooks/availableevents
get
Retrieves a webhook available events
/cpaas/accesstokens/availabletemplates
get
Gets a list of available events templates that the caller can use when creating webhook
/cpaas/webhooks/{webhookId}
get
Retrieves a webhook configuration
put
Updates a webhook configuration
delete
Deletes a webhook configuration
Chat API
/cpaas/chats/{chatId}
get
Retrieves a chat
put
Updates a chat
delete
Deletes a chat
/cpaas/chats/{chatId}/assign
put
Assigns a chat
/cpaas/chats/{chatId}/close
put
Closes a chat
/cpaas/chats/{chatId}/channel
put
Changes the channel for an existing chat
/cpaas/chats/{chatId}/form
post
Sends a form to a chat
/cpaas/chats
post
Creates a new chat
get
Retrieves a list of chats
/cpaas/chats/{chatId}/typing
post
Indicates that the caller is typing in this chat
delete
Indicates that the caller has stopped typing in this chat
/cpaas/chats/{chatId}/participants
get
Retrieves the chat participants
Chat Message API
/cpaas/chats/{chatId}/events
get
Retrieves a chat's events
/cpaas/chats/{chatId}/messages
post
Sends a message to chat
get
Retrieves a chat's messages from an point (event) in time and works backwards
/cpaas/chats/{chatId}/messages/statusupdates
post
Posts message updates back
Chat Presence API
/cpaas/presence
get
Retrieves the presence for a list of agent's profileIds
/cpaas/presence/appmessaging
get
Retrieves the presence for a list of user's profileIds
Chat Config API
/cpaas/chat/config
get
Retrieves the chat configuration for an apiSpace
/cpaas/chat/config/teams/{teamId}
get
Retrieves the members of a team
delete
Removes the config for a team
/cpaas/chat/config/teams/{teamId}/appMessaging
put
Update the App Messaging config for a team
delete
Removes the App Messaging config for a team
/cpaas/chat/config/teams/{teamId}/settings
put
Update general settings for a team
delete
Removes the settings for a team
Reference
SMS Message Statuses
MIME Types