Jump to Content

Guides Recipes API Reference

Home Guides Recipes API Reference

Guides Recipes API Reference Log in Help centre

API Reference

Log in Help centre

Accounts and Utilities

Get account informationget
Get server timeget
Empty recycle binpost

Contacts and Data

Address books / lists
Unified contacts
Email Contacts
Contact data fields
Preferences and subscriptions
Segments
Scoring

Insight Data

Insight data
Bulk import
- Bulk imports Insight dataput
- Retrieve the status of a Insight data import requestget
Account collections
Contacts collections

Marketing and Automation

Campaigns
Campaign Templates
Documents
Images
Pages and forms
Programs
Product recommendations
- Get all product recommendationsget
SMS campaigns

Communications

App Messaging
Content API
Email2SMS
Omnichannel messaging
Omnichannel channels
Omnichannel API
Phone number validation
- Validates a single phone numberget
Templates
Transactional email
Webhooks
Webhooks API

Session API

/cpaas/sessions/tokens/anon
- Gets a token that can be used to start an anonymous sessionget
/cpaas/sessions/{id}
- Retrieves details about a sessionget
- Ends a session, revoking access to services.delete

Analytics API

/cpaas/analytics/conversationmessages
- Retrieves conversation message analyticsget
/cpaas/analytics/messages
- Retrieves message analyticsget
/cpaas/analytics/sessions
- Retrieves session analyticsget
/cpaas/analytics/sms/tracking
- Retrieves url tracking analyticsget
/cpaas/analytics/sms/verify
- Retrieves sms verify analyticsget
/cpaas/analytics/sms/inbound
- Retrieves inbound SMS analyticsget
/cpaas/analytics/sms/outbound
- Retrieves outbound SMS analyticsget

API Space Management API

/apispaces/{id}
/apispaces
- Retrieves all API Spaces accessible by the current userget
- Creates a new API Spacepost
/apispaces/{id}/auth
- Retrieves an API Space's authentication configurationget
- Updates an API Space's authentication configurationput
/apispaces/{id}/push
- Retrieves an API Space's push configurationget
/apispaces/{id}/retention
- Retrieves an API Space's data retention configurationget
- Updates an API Space's data retention configurationput
/apispaces/{id}/push/apns
- Updates an API Space's APNS push certificate configurationput
/apispaces/{id}/push/apns/{bundleId}/{environment}
- Deletes a specific bundle from an API Space's APNS push configurationdelete
/apispaces/{id}/push/apns/{bundleId}/{environment}/cert
- Retrieves a bundle's APNS certificateget
/apispaces/{id}/push/apnstoken
- Updates an API Space's APNS push token configurationput
- Deletes the APNS push token configuration from an API Space's APNS push configurationdelete
/apispaces/{id}/push/apnstoken/key
- Retrieves the APNS key file for the API Spaceget
/apispaces/{id}/push/fcm/v1/{package}
- Updates an API Space's FCM push configurationput

Chat Config API

/cpaas/chat/config
- Retrieves the chat configuration for an apiSpaceget
/cpaas/chat/config/teams/{teamId}
- Retrieves the members of a teamget
- Removes the config for a teamdelete
/cpaas/chat/config/teams/{teamId}/appMessaging
- Update the App Messaging config for a teamput
- Removes the App Messaging config for a teamdelete
/cpaas/chat/config/teams/{teamId}/settings
- Update general settings for a teamput
- Removes the settings for a teamdelete

Chat Message API

/cpaas/chats/{chatId}/events
- Retrieves a chat's eventsget
/cpaas/chats/{chatId}/messages
- Retrieves a chat's messages from an point (event) in time and works backwardsget
- Sends a message to chatpost
/cpaas/chats/{chatId}/messages/statusupdates
- Posts message updates backpost

Chat API

/cpaas/chats/{chatId}
/cpaas/chats/{chatId}/assign
- Assigns a chatput
/cpaas/chats/{chatId}/close
- Closes a chatput
/cpaas/chats/{chatId}/channel
- Changes the channel for an existing chatput
/cpaas/chats/{chatId}/form
- Sends a form to a chatpost
/cpaas/chats
- Retrieves a list of chatsget
- Creates a new chatpost
/cpaas/chats/{chatId}/typing
- Indicates that the caller is typing in this chatpost
- Indicates that the caller has stopped typing in this chatdelete
/cpaas/chats/{chatId}/participants
- Retrieves the chat participantsget

Conversation Message API

/cpaas/conversations/{conversationId}/events
- Retrieves a conversation's eventsget
/cpaas/conversations/{conversationId}/messages
- Retrieves a conversation's messages from an point (event) in time and works backwardsget
- Sends a message to conversationpost
/cpaas/conversations/{conversationId}/messages/statusupdates
- Posts message updates backpost

Conversation API

/cpaas/conversations/{conversationId}
/cpaas/conversations
- Retrieves a list of conversationsget
- Creates a new conversationpost
/cpaas/conversations/{conversationId}/typing
- Indicates that the caller is typing in this conversationpost
- Indicates that the caller has stopped typing in this conversationdelete
/cpaas/conversations/{conversationId}/participants

Message Rules API

/cpaas/automation/inboundrules
- Retrieves a message rules configuration listget
- Create a message rule configurationpost
/cpaas/automation/inboundrules/{messageRulesId}

Chat Presence API

/cpaas/presence
- Retrieves the presence for a list of agent's profileIdsget
/cpaas/presence/appmessaging
- Retrieves the presence for a list of user's profileIdsget

Profile API

/cpaas/profiles/export
- Exports the result of a profile query in a formatted file for downloadpost
/cpaas/profiles/bulk
- Deletes the requested profilesdelete
- Creates or updates the supplied profiles with the supplied datapatch
/cpaas/profiles/{id}
/cpaas/profiles/{id}/optin
- Set profile opt in for specified channelsput
- Set profile opt in for specified channelsdelete
/cpaas/profiles/{id}/rels/primary/{linkedId}
- Creates a relationship where the linked profile is the primary and this profile is a childput
- Deletes the profile's relationship to a primary profiledelete
/cpaas/profiles/{id}/rels/link/{linkedId}
- Creates a relationship where this profile is the primary and the linked profile is a childput
- Deletes the primary profile's relationship to a linked Profiledelete
/apispaces/{apiSpaceId}/profiles/{id}/devices/{deviceId}
- Removes device from profile and closes related opened sessionsdelete
/apispaces/{apiSpaceId}/profiles/devices/push/validation
- Retrieves push capabilities summarypost
/cpaas/profiles
- Query profilesget
- Creates a new Profilepost
/cpaas/profiles/optin
- Gets default profiles opt in/out options for each channel in channel serviceget
- Set default profiles opt in/out options for each channel in channel serviceput

Deprecated

Address books
- Bulk import contacts in address bookpost
Contacts
Insight and transactional data
SMS campaigns
SOAP API
SOAP - Account
- GetCurrentAccountInfo
- EmptyRecycleBin
SOAP - Address books
SOAP - Campaigns
SOAP - Contacts
SOAP - Contact data fields
SOAP - Custom from addresses
- GetCustomFromAddresses
SOAP - Document folders
SOAP - Image folders
SOAP - Pages and forms
SOAP - Preferences
SOAP - Product recommendations
- GetProductRecommendations
SOAP - Programs
SOAP - Segments
SOAP - Server time
- GetServerTime
SOAP - SMS
SOAP - Templates
SOAP - Transactional email
SOAP - Transactional data

Omnichannel API

/cpaas/messages/{messageId}/statuses/{status}
/cpaas/messages/{messageId}
/cpaas/messages
/cpaas/messages/batch
/cpaas/messages/inbounds
/cpaas/messages/inbounds/{inboundMessageId}/statuses/{status}

Facebook API

Facebook Meta Data Servicepost

Accounts and Utilities

Get account informationget
Get server timeget
Empty recycle binpost

Contacts and Data

Address books / lists
Unified contacts
Email Contacts
Contact data fields
Preferences and subscriptions
Segments
Scoring

Insight Data

Insight data
Bulk import
- Bulk imports Insight dataput
- Retrieve the status of a Insight data import requestget
Account collections
Contacts collections

Marketing and Automation

Campaigns
Campaign Templates
Documents
Images
Pages and forms
Programs
Product recommendations
- Get all product recommendationsget
SMS campaigns

Communications

App Messaging
Content API
Email2SMS
Omnichannel messaging
Omnichannel channels
Omnichannel API
Phone number validation
- Validates a single phone numberget
Templates
Transactional email
Webhooks
Webhooks API

Session API

/cpaas/sessions/tokens/anon
- Gets a token that can be used to start an anonymous sessionget
/cpaas/sessions/{id}
- Retrieves details about a sessionget
- Ends a session, revoking access to services.delete

Analytics API

/cpaas/analytics/conversationmessages
- Retrieves conversation message analyticsget
/cpaas/analytics/messages
- Retrieves message analyticsget
/cpaas/analytics/sessions
- Retrieves session analyticsget
/cpaas/analytics/sms/tracking
- Retrieves url tracking analyticsget
/cpaas/analytics/sms/verify
- Retrieves sms verify analyticsget
/cpaas/analytics/sms/inbound
- Retrieves inbound SMS analyticsget
/cpaas/analytics/sms/outbound
- Retrieves outbound SMS analyticsget

API Space Management API

/apispaces/{id}
/apispaces
- Retrieves all API Spaces accessible by the current userget
- Creates a new API Spacepost
/apispaces/{id}/auth
- Retrieves an API Space's authentication configurationget
- Updates an API Space's authentication configurationput
/apispaces/{id}/push
- Retrieves an API Space's push configurationget
/apispaces/{id}/retention
- Retrieves an API Space's data retention configurationget
- Updates an API Space's data retention configurationput
/apispaces/{id}/push/apns
- Updates an API Space's APNS push certificate configurationput
/apispaces/{id}/push/apns/{bundleId}/{environment}
- Deletes a specific bundle from an API Space's APNS push configurationdelete
/apispaces/{id}/push/apns/{bundleId}/{environment}/cert
- Retrieves a bundle's APNS certificateget
/apispaces/{id}/push/apnstoken
- Updates an API Space's APNS push token configurationput
- Deletes the APNS push token configuration from an API Space's APNS push configurationdelete
/apispaces/{id}/push/apnstoken/key
- Retrieves the APNS key file for the API Spaceget
/apispaces/{id}/push/fcm/v1/{package}
- Updates an API Space's FCM push configurationput

Chat Config API

/cpaas/chat/config
- Retrieves the chat configuration for an apiSpaceget
/cpaas/chat/config/teams/{teamId}
- Retrieves the members of a teamget
- Removes the config for a teamdelete
/cpaas/chat/config/teams/{teamId}/appMessaging
- Update the App Messaging config for a teamput
- Removes the App Messaging config for a teamdelete
/cpaas/chat/config/teams/{teamId}/settings
- Update general settings for a teamput
- Removes the settings for a teamdelete

Chat Message API

/cpaas/chats/{chatId}/events
- Retrieves a chat's eventsget
/cpaas/chats/{chatId}/messages
- Retrieves a chat's messages from an point (event) in time and works backwardsget
- Sends a message to chatpost
/cpaas/chats/{chatId}/messages/statusupdates
- Posts message updates backpost

Chat API

/cpaas/chats/{chatId}
/cpaas/chats/{chatId}/assign
- Assigns a chatput
/cpaas/chats/{chatId}/close
- Closes a chatput
/cpaas/chats/{chatId}/channel
- Changes the channel for an existing chatput
/cpaas/chats/{chatId}/form
- Sends a form to a chatpost
/cpaas/chats
- Retrieves a list of chatsget
- Creates a new chatpost
/cpaas/chats/{chatId}/typing
- Indicates that the caller is typing in this chatpost
- Indicates that the caller has stopped typing in this chatdelete
/cpaas/chats/{chatId}/participants
- Retrieves the chat participantsget

Conversation Message API

/cpaas/conversations/{conversationId}/events
- Retrieves a conversation's eventsget
/cpaas/conversations/{conversationId}/messages
- Retrieves a conversation's messages from an point (event) in time and works backwardsget
- Sends a message to conversationpost
/cpaas/conversations/{conversationId}/messages/statusupdates
- Posts message updates backpost

Conversation API

/cpaas/conversations/{conversationId}
/cpaas/conversations
- Retrieves a list of conversationsget
- Creates a new conversationpost
/cpaas/conversations/{conversationId}/typing
- Indicates that the caller is typing in this conversationpost
- Indicates that the caller has stopped typing in this conversationdelete
/cpaas/conversations/{conversationId}/participants

Message Rules API

/cpaas/automation/inboundrules
- Retrieves a message rules configuration listget
- Create a message rule configurationpost
/cpaas/automation/inboundrules/{messageRulesId}

Chat Presence API

/cpaas/presence
- Retrieves the presence for a list of agent's profileIdsget
/cpaas/presence/appmessaging
- Retrieves the presence for a list of user's profileIdsget

Profile API

/cpaas/profiles/export
- Exports the result of a profile query in a formatted file for downloadpost
/cpaas/profiles/bulk
- Deletes the requested profilesdelete
- Creates or updates the supplied profiles with the supplied datapatch
/cpaas/profiles/{id}
/cpaas/profiles/{id}/optin
- Set profile opt in for specified channelsput
- Set profile opt in for specified channelsdelete
/cpaas/profiles/{id}/rels/primary/{linkedId}
- Creates a relationship where the linked profile is the primary and this profile is a childput
- Deletes the profile's relationship to a primary profiledelete
/cpaas/profiles/{id}/rels/link/{linkedId}
- Creates a relationship where this profile is the primary and the linked profile is a childput
- Deletes the primary profile's relationship to a linked Profiledelete
/apispaces/{apiSpaceId}/profiles/{id}/devices/{deviceId}
- Removes device from profile and closes related opened sessionsdelete
/apispaces/{apiSpaceId}/profiles/devices/push/validation
- Retrieves push capabilities summarypost
/cpaas/profiles
- Query profilesget
- Creates a new Profilepost
/cpaas/profiles/optin
- Gets default profiles opt in/out options for each channel in channel serviceget
- Set default profiles opt in/out options for each channel in channel serviceput

Deprecated

Address books
- Bulk import contacts in address bookpost
Contacts
Insight and transactional data
SMS campaigns
SOAP API
SOAP - Account
- GetCurrentAccountInfo
- EmptyRecycleBin
SOAP - Address books
SOAP - Campaigns
SOAP - Contacts
SOAP - Contact data fields
SOAP - Custom from addresses
- GetCustomFromAddresses
SOAP - Document folders
SOAP - Image folders
SOAP - Pages and forms
SOAP - Preferences
SOAP - Product recommendations
- GetProductRecommendations
SOAP - Programs
SOAP - Segments
SOAP - Server time
- GetServerTime
SOAP - SMS
SOAP - Templates
SOAP - Transactional email
SOAP - Transactional data

Omnichannel API

/cpaas/messages/{messageId}/statuses/{status}
/cpaas/messages/{messageId}
/cpaas/messages
/cpaas/messages/batch
/cpaas/messages/inbounds
/cpaas/messages/inbounds/{inboundMessageId}/statuses/{status}

Facebook API

Facebook Meta Data Servicepost

Updates a webhook configuration

put https://{region}-api.dotdigital.com/cpaas/webhooks/{webhookId}

Language

Credentials

Basic

base64

:

URL

Click Try It! to start a request and see the response here!