Jump to Content

Guides Recipes API Reference

Home Guides Recipes API Reference

Guides Recipes API Reference Select product Log in Help centre

API Reference

Select product Log in Help centre

All

Pages

Start typing to search…

Accounts and Utilities

Get account informationget
Get server timeget
Empty recycle binpost

Contacts and Data

Contacts
Custom identifiers
Contact data fields
Lists / Address books
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

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

Events

Events overview
Import events
- Import a collection of eventspost
Export events
- Retrieve eventsget
Subscriptions
Large objects
- Retrieve large objectget

Data Firehose

Data Firehose

Communications

App Messaging
Content API
Email2SMS
Omnichannel messaging
Omnichannel channels
Omnichannel API
Phone number validation
Templates
Transactional email
Webhooks
Webhooks API

WhatsApp Channel API

WhatsApp configurations
- Get WhatsApp configuration for API Spaceget
- Creates WhatsApp configurationpost
WhatsApp numbers
WhatsApp templates
- Get WhatsApp templatesget
- Get WhatsApp templateget

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.del

Phone Number Validation API

Single number
- Validate a single numberget
Bulk validation

Analytics API

App Messaging
- Retrieves conversation message analyticsget
- Retrieves session analyticsget
Chat
- Retrieves chat analyticsget
- Retrieves live chat analyticsget
Messaging
- Retrieves message analyticsget
- Retrieves message metricsget
SMS
WhatsApp
- Retrieves WhatsApp conversation analyticsget
- Retrieves WhatsApp business-initiated conversation analytics for the last 24 hours (Daily message usage)get

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 teamdel
/cpaas/chat/config/teams/{teamId}/appMessaging
- Update the App Messaging config for a teamput
- Removes the App Messaging config for a teamdel
/cpaas/chat/config/teams/{teamId}/settings
- Update general settings for a teamput
- Removes the settings for a teamdel

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 chatdel
/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 conversationdel
/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 profilesdel
- 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 channelsdel
/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 profiledel
/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 Profiledel
/apispaces/{apiSpaceId}/profiles/{id}/devices/{deviceId}
- Removes device from profile and closes related opened sessionsdel
/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
Email Campaigns
- Get all campaignsget
Email Contacts
Facebook API
- Facebook Meta Data Servicepost
Insight and transactional data
SOAP API

Powered by

Update campaign

put

https://{region}-api.dotdigital.com/v2/campaigns/{id}

Updates a given campaign

Language

Credentials

Basic

base64

:

URL

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