dotdigital Engagement Cloud
Engagement Cloud API
Engagement Cloud API Reference
CPaaS API
CPaaS API Reference
{{user.name}}
Log In
Help centre
The dotdigital Engagement Cloud developer hub
Official dotdigital Engagement Cloud APIs documentation
Home
Engagement Cloud API
Engagement Cloud API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Engagement Cloud API
Engagement Cloud API Reference
discard
Save Edits
Submit
Suggested Edits
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.projectName ? 'in ' + result.projectName : ''}}
{{result._method}}
Reference {{result.projectName ? 'in ' + result.projectName : ''}}
Changelog {{result.projectName ? 'in ' + result.projectName : ''}}
Discussions {{result.projectName ? 'in ' + result.projectName : ''}}
Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results
Get started
Getting started with the API
Error response types
FAQs
Push notifications
Setting up push notifications
Creating a push notification profile in Engagement Cloud
Creating a JWT
Using the Android App Messaging SDK
Using the iOS SDK
Using the JavaScript SDK with cross-platform apps
Registering your app users for push
Integration
Add products to your product catalog (AccountInsight)
Using OAuth 2.0 with Engagement Cloud
Quick Starts
Exporting data from email campaign reports
Sending a transactional email as a triggered campaign
Support
REST
About our REST API
Account information
get
Get account information
post
Empty recycle bin
Address books
post
Create address book
delete
Delete address book
put
Update address book
get
Get address book
get
Get address books
get
Get private address books
get
Get public address books
Campaigns
post
Create campaign
post
Create split test campaign (beta)
put
Update campaign
post
Copy campaign
delete
Delete campaign
post
Send campaign
post
Send time optimised campaign
get
Get campaign send status
post
Add campaign attachment
delete
Remove campaign attachment
get
Get campaign attachments
get
Get all campaigns
get
Get campaigns sent to address book or segment
get
Get campaign
get
Get campaign with details
get
Get campaign summary
get
Get campaign opens
get
Get campaign opens for a contact
get
Get campaign activity for a contact
get
Get campaign activity since date
get
Get campaign clicks
get
Get campaign clicks and link groups
get
Get campaign clicks since date
get
Get campaign clicks and link groups since date
get
Get campaign opens since date
get
Get campaign activity
get
Get campaign address books
get
Get campaign clicks for a contact
get
Get campaign contact clicks and link groups
get
Get campaigns with activity since date
get
Get campaign page views for a contact
get
Get campaign page views since date
get
Get campaign replies for a contact
get
Get campaign ROI activity for a contact
get
Get campaign ROI activity since date
get
Get campaign social bookmark views
get
Get campaign social bookmark views for a contact
get
Get campaign hard bouncers
get
Get campaign split test results (beta)
Contacts
post
Create contact
post
Create contact with consent
post
Create contact with consent and preferences
post
Bulk import contacts
post
Bulk import contacts in address book
post
Bulk import contacts in address book with merge option
put
Update contact
put
Update contact with consent
put
Update contact with consent and preferences
delete
Delete contact
delete
Delete contact from address book
post
Delete contacts from address book
delete
Delete all contacts from address book
post
Add contact to address book
get
Get contact by email
get
Get contact by ID
get
Get all contacts count
get
Get contact address books
get
Get contacts
get
Get contacts created since date
get
Get contact import status
get
Get contact import report
get
Get contact import report faults
get
Get contacts from address book
get
Get modified contacts in address book since date
get
Get modified contacts since date
get
Get suppressed contacts since date
get
Get unsubscribed contacts since date
get
Get unsubscribed contacts from address book since date
post
Unsubscribe contact
post
Unsubscribe contact from address book
post
Resubscribe contact
post
Resubscribe contact to address book
post
Resubscribe contact with no challenge
post
Resubscribe contact to address book with no challenge
get
Get scoring for contacts
get
Get scoring for contacts in address book
get
Get scoring modified since date for contacts
get
Get scoring for contact by email
get
Get scoring for contact by ID
get
Get contact by ID with consent
get
Get contact by email with consent
put
Set preferences for contact
get
Get contacts opted into a preference and an address book
get
Get contacts opted into a preference
get
Get contacts with modified preference opt-in since date
get
Get contacts with modified preference opt-in in address book since date
get
Get preferences for contact
get
Get subscriptions for contact
Contact data fields
post
Create contact data field
delete
Delete contact data field
get
Get contact data fields
Custom from addresses
get
Get custom from addresses
Document folders
post
Create document folder
get
Get document folders
get
Get documents in folder
post
Upload document
Image folders
post
Create image folder
get
Get image folders
get
Get image folder by ID
post
Upload campaign image
Preferences
post
Create preference
put
Update preference
delete
Delete preference
get
Get preferences
get
Get modified preferences since date
Product recommendations
get
Get all product recommendations
Programs
post
Create program enrolment
get
Get programs
get
Get program by ID
get
Get program enrolment report faults
get
Get program enrolment
get
Get program enrolments by status
Segments
get
Get segments
post
Refresh segment
get
Get refresh progress for segment
Server time
get
Get server time
SMS
post
Send SMS message
post
Create SMS campaign
get
Get SMS campaign
get
Get SMS campaigns
delete
Delete SMS campaign
put
Update SMS campaign
Survey and forms
get
Get surveys
get
Get survey by ID
get
Get survey responses
get
Get survey fields
get
Get survey responses with activity since date
get
Get surveys with activity since date
Transactional data
post
Add transactional data to contact
post
Bulk add transactional data to contacts
post
Replace transactional data by key
delete
Delete transactional data collection for contact by email
delete
Delete transactional data by key
delete
Delete transactional data collection for contact by ID
get
Get transactional data import status
get
Get transactional data import report
get
Get transactional data collection for contact by email
get
Get transactional data by key
get
Get account scoped transactional data
Transactional email
post
Send transactional email using a triggered campaign
post
Send transactional email
get
Get transactional email statistics
Templates
post
Create template
get
Get template by ID
get
Get templates
put
Update template
SOAP
About our SOAP API
Account information
GetCurrentAccountInfo
EmptyRecycleBin
Address books
CreateAddressBook
UpdateAddressBook
DeleteAddressBook
GetAddressBooks
GetAddressBookById
GetAddressBooksForCampaign
GetAddressBooksForContact
Campaigns
CreateSplitTestCampaign (beta)
CreateCampaign
UpdateCampaign
SendCampaign
CopyCampaign
DeleteCampaign
SendTimeOptimisedCampaign
GetCampaignSendProgress
AttachDocumentToCampaign
DetachDocumentFromCampaign
GetCampaignAttachments
GetCampaigns
GetCampaignsForAddressBook
GetCampaignById
GetCampaignSummary
GetCampaignWithDetails
GetCampaignOpens
GetCampaignOpensSinceDate
GetCampaignActivities
GetCampaignActivitiesSinceDate
GetSentCampaignsWithActivitySinceDate
GetCampaignClicks
GetCampaignClicksSinceDate
GetCampaignClicksAndLinkGroups
GetCampaignClicksAndLinkGroupsSinceDate
GetCampaignPageViewsSinceDate
GetCampaignContactActivity
GetCampaignContactClicks
GetCampaignContactClicksAndLinkGroups
GetCampaignContactOpens
GetCampaignContactPageViews
GetCampaignContactReplies
GetCampaignContactRoiDetails
GetCampaignRoiDetailsSinceDate
GetCampaignContactSocialBookmarkViews
GetCampaignSocialBookmarkViews
GetCampaignHardBouncingContacts
GetCampaignSplitTestResults (beta)
Contacts
CreateContactWithConsent
CreateContact
CreateContactWithConsentAndPreferences
DeleteContact
UpdateContact
UpdateContactWithConsent
UpdateContactWithConsentAndPreferences
AddContactToAddressBook
DeleteContactFromAddressBook
DeleteContactsFromAddressBook
DeleteAllContactsFromAddressBook
GetContactByEmail
GetContactById
GetAllAccountContactsCount
GetContacts
GetModifiedContacts
GetNewContacts
ImportContacts
ImportContactsToAddressBook
GetContactImportProgress
ImportContactsToAddressBookWithMergeOption
GetContactImportReport
GetContactImportReportFaults
GetContactsInAddressBook
GetModifiedContactsInAddressBook
GetSuppressedContacts
GetUnsubscribedContacts
GetUnsubscribedContactsInAddressBook
UnsubscribeContact
UnsubscribeContactFromAddressBook
ResubscribeContact
ResubscribeContactWithNoChallenge
ResubscribeContactToAddressBook
ResubscribeContactToAddressBookWithNoChallenge
GetContactsScore
GetContactsScoreInAddressBook
GetContactsScoreModifiedSinceDate
GetContactScoreByEmail
GetContactScoreByContactId
GetContactByIdWithConsent
GetContactByEmailWithConsent
GetContactsInAddressBookWithPreference
GetContactsWithPreference
GetModifiedPreferenceOptIns
GetModifiedPreferencesOptInsByAddressBook
Contact data fields
CreateDataField
DeleteDataField
GetDataFields
Custom from addresses
GetCustomFromAddresses
Document folders
CreateDocumentFolder
GetDocumentFolders
UploadDocument
GetDocuments
Image folders
CreateImageFolder
GetImageFolders
UploadImage
GetImageFolderById
Preferences
CreatePreference
SetPreferencesForContact
UpdatePreference
DeletePreference
GetPreferences
GetPreferencesForContact
GetPreferencesModifiedSinceDate
Product recommendations
GetProductRecommendations
Programs
CreateEnrolment
GetPrograms
GetProgramById
GetEnrolmentReport
GetEnrolmentsByStatus
GetEnrolmentById
Segments
GetSegments
GetSegmentRefreshProgress
RefreshSegment
Server time
GetServerTime
SMS
SendSingleSmsMessage
CreateSMSCampaign
GetSMSCampaigns
GetSMSCampaign
UpdateSMSCampaign
DeleteSMSCampaign
Surveys and forms
GetSurveys
GetSurveyById
GetSurveyFields
GetSurveyResponses
GetSurveyResponsesWithActivitySinceDate
GetSurveysWithActivitySinceDate
Templates
GetTemplates
CreateTemplate
UpdateTemplate
GetTemplateById
Transactional email
SendTransactionalEmail
SendTransactionalEmailTriggeredCampaign
GetTransactionalEmailStatistics
Transactional data
AddTransactionalData
ImportTransactionalData
ReplaceTransactionalDataByKey
DeleteTransactionalDataByContact
DeleteTransactionalDataByKey
GetTransactionalDataImportProgress
GetTransactionalDataImportReport
GetTransactionalDataByContact
GetTransactionalDataByKey
GetAccountScopedTransactionalData