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
API Reference
CreateCampaign
All
Pages
Start typing to search…
JUMP TO
OAS and Swagger
Downloading OAS / Swagger specifications
Accounts and Utilities
Get account information
get
Get server time
get
Empty recycle bin
post
Contacts and Data
Contacts
Get contacts based on your criteria
get
Retrieve the status of a contacts import request
get
Import contact collection
put
Retrieve a contact by an identifier
get
Retrieve the status of a delete contacts job
get
Delete multiple contacts
post
Create a contact
post
Replace a contact
put
Deletes a contact using a specific identifier
del
Import a single contact
patch
Custom identifiers
Get all custom identifiers
get
Create a custom identifier
post
Delete a custom identifier by name
del
Contact data fields
Create contact data field
post
Delete contact data field
del
Get contact data fields
get
Lists / Address books
Create list
post
Delete list
del
Update list
put
Get list
get
Get lists
get
Get private lists
get
Get public lists
get
Get unsubscribed from list since date
get
Unsubscribe contact from list
post
Resubscribe contact to list
post
Resubscribe contact to list with no challenge
post
Delete contact from list
del
Delete contacts from list
post
Delete all contacts from list
post
Get bulk contact deletion progress
get
Preferences and subscriptions
Unsubscribe contact
post
Bulk suppress contacts
put
Resubscribe contact
post
Resubscribe contact with no challenge
post
Get suppressed contacts since date
get
Get subscriptions for contact
get
Get unsubscribed contacts since date
get
Create preference
post
Update preference
put
Get preferences
get
Get modified preferences since date
get
Delete preference
del
Set preferences for contact
put
Get 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
Segments
Get segments
get
Refresh segment
post
Get refresh progress for segment
get
Scoring
Get scoring for contacts
get
Get scoring modified since date for contacts
get
Get scoring for contact
get
Get scoring for contacts in address book
get
Insight Data
Insight data
Retrieve the status of an asynchronous request
get
Lists all Insight data collections
get
Creates an Insight data collection
post
Empties an Insight data collection
del
Gets the JSON schema for an Insight data collection
get
Deletes an Insight data collection
del
Bulk import
Bulk imports Insight data
put
Retrieve the status of a Insight data import request
get
Account collections
List account Insight data collections
get
Retrieves records from an accounts Insight data collection
get
Retrieve single record from an account Insight data collection
get
Upsert record into an account Insight data collection
put
Delete record from an account Insight data collection
del
Contacts collections
Retrieve data for contact-scoped Insight data collection
get
Retrieve records for a contact from Insight data collection
get
List Insight data collections for a contact
get
Empty Insight data collection for a contact
del
Retrieve Insight data record for a contact
get
Upsert record into Insight data collection for a contact
put
Delete record from Insight data collection for a contact
del
Marketing and Automation
Email Campaigns
Create email campaign
post
Create split test email campaign
post
Update email campaign
put
Copy email campaign
post
Delete email campaign
del
Send email campaign
post
Send time optimised email campaign
post
Get email campaign send status
get
Add campaign attachment
post
Remove campaign attachment
del
Get email campaign attachments
get
Get email campaigns with activity since date
get
Get all email campaigns (with filters)
get
Get email campaigns sent to address book or segment
get
Get email campaign
get
Get email campaign with details
get
Get email campaign summary
get
Get email campaign opens
get
Get email campaign opens for a contact
get
Get email campaign activity for a contact
get
Get email campaign activity since date
get
Get email campaign clicks
get
Get email campaign clicks and link groups
get
Get email campaign clicks since date
get
Get email campaign clicks and link groups since date
get
Get email campaign opens since date
get
Get email campaign activity
get
Get email campaign address books
get
Get email campaign clicks for a contact
get
Get email campaign contact clicks and link groups
get
Get email campaign page views for a contact
get
Get email campaign page views since date
get
Get email campaign replies for a contact
get
Get email campaign ROI activity for a contact
get
Get email campaign ROI activity since date
get
Get email campaign social bookmark views
get
Get email campaign social bookmark views for a contact
get
Get email campaign hard bouncers
get
Get email campaign split test results
get
Get custom from addresses
get
Get email campaign revenue since date
get
Get email campaign revenue for contact
get
Campaign Templates
Create template
post
Get template by id
get
Get templates
get
Update template
put
Documents
Create document folder
post
Get document folders
get
Get documents in folder
get
Upload document
post
Images
Create image folder
post
Get image folders
get
Get image folders by id
get
Upload campaign image
post
Pages and forms
Get forms
get
Get form by ID
get
Get forms with activity since date
get
Get form fields
get
Get form responses
get
Get form responses with activity since date
get
Programs
Create program enrolment
post
Get programs
get
Get program by ID
get
Get program enrolment report faults
get
Get program enrolment
get
Get program enrolments by status
get
Product recommendations
Get all product recommendations
get
SMS campaigns
Create SMS campaign
post
Copy SMS campaign
post
Get SMS campaign
get
Get SMS campaigns
get
Update SMS campaign
put
Delete SMS campaign
del
Send SMS message
post
Events
Events overview
Import events
Import a collection of events
post
Export events
Retrieve events
get
Subscriptions
List subscriptions
get
Create subscription
post
Gets subscription
get
Update subscription
put
Deletes subscription
del
Large objects
Retrieve large object
get
Data Firehose
Data Firehose
Add configuration
post
Get configuration
get
Update configuration
put
Update configuration status
put
Delete configuration
del
Communications
App Messaging
Registering your app users
Creating a JWT for an app user
Android
iOS
Javascript
Cordova
Content API
Upload a file
post
Retrieve a file
get
Delete a file
del
Email2SMS
Omnichannel messaging
Calling the Omnichannel API
Addressing your messages
Channel selection
Cross channel messaging
Custom messages
Multi part messages
Templates
Additional options
Message send response
Inbound messages and receipts
Omnichannel channels
SMS
Get SMS phone numbers
get
Get SMS shortcodes
get
Get SMS keywords
get
MMS
Push
WhatsApp
App Messaging
Omnichannel API
Send a batch of new messages
post
Send a new message
post
Retrieves the current state of a specific message.
get
Deletes a Message
del
Patches a Message
patch
Posts an inbound message
post
Posts a status for an inbound
post
Posts a status for a message
post
Retrieves message history for a profile
get
Phone number validation
Templates
Create a template
post
Retrieves a list of all available templates
get
Retrieves a template
get
Updates a template
put
Deletes a template
del
Transactional email
Send transactional email
post
Send batch transactional email
post
Send transactional email using a triggered campaign
post
Send batch transactional email using a triggered campaign
post
Get transactional email statistics
get
Transactional Email via SMTP
Webhooks
Message Events
Omnichannel Profile Events
Facebook Events
App Messaging - Conversation Events
App Messaging - Message Events
App Messaging - Session Events
Chat - Events
Chat - Message Events
Chat - Presence Events
Webhooks API
Get webhooks
get
Create webhook
post
Retrieves available webhook events
get
Get event templates
get
Retrieves webhook configuration
get
Update webhook configuration
put
Deletes webhook
del
WhatsApp Channel API
WhatsApp configurations
Get WhatsApp configuration for API Space
get
Creates WhatsApp configuration
post
WhatsApp numbers
Get WhatsApp number
get
Removes WhatsApp number
del
Registers WhatsApp number
post
WhatsApp templates
Get WhatsApp templates
get
Get WhatsApp template
get
Session API
/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
get
Ends a session, revoking access to services.
del
Phone Number Validation API
Single number
Validate a single number
get
Bulk validation
List bulk validation jobs.
get
Bulk validate numbers
post
Get bulk job details
get
Get bulk job results
get
Analytics API
App Messaging
Retrieves conversation message analytics
get
Retrieves session analytics
get
Chat
Retrieves chat analytics
get
Retrieves live chat analytics
get
Messaging
Retrieves message analytics
get
Retrieves message metrics
get
SMS
Retrieves url tracking analytics
get
Retrieves sms verify analytics
get
Retrieves inbound SMS analytics
get
Retrieves outbound SMS analytics
get
WhatsApp
Retrieves WhatsApp conversation analytics
get
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 apiSpace
get
/cpaas/chat/config/teams/{teamId}
Retrieves the members of a team
get
Removes the config for a team
del
/cpaas/chat/config/teams/{teamId}/appMessaging
Update the App Messaging config for a team
put
Removes the App Messaging config for a team
del
/cpaas/chat/config/teams/{teamId}/settings
Update general settings for a team
put
Removes the settings for a team
del
Chat Message API
/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
get
Sends a message to chat
post
/cpaas/chats/{chatId}/messages/statusupdates
Posts message updates back
post
Chat API
/cpaas/chats/{chatId}
Retrieves a chat
get
Updates a chat
put
Deletes a chat
del
/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
put
/cpaas/chats/{chatId}/form
Sends a form to a chat
post
/cpaas/chats
Retrieves a list of chats
get
Creates a new chat
post
/cpaas/chats/{chatId}/typing
Indicates that the caller is typing in this chat
post
Indicates that the caller has stopped typing in this chat
del
/cpaas/chats/{chatId}/participants
Retrieves the chat participants
get
Conversation Message API
/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 backwards
get
Sends a message to conversation
post
/cpaas/conversations/{conversationId}/messages/statusupdates
Posts message updates back
post
Conversation API
/cpaas/conversations/{conversationId}
Retrieves a conversation
get
Updates a conversation
put
Deletes a conversation
del
/cpaas/conversations
Retrieves a list of conversations
get
Creates a new conversation
post
/cpaas/conversations/{conversationId}/typing
Indicates that the caller is typing in this conversation
post
Indicates that the caller has stopped typing in this conversation
del
/cpaas/conversations/{conversationId}/participants
Retrieves the conversation participants
get
Adds a list of participants to a conversation
post
Deletes a list of participants from a conversation
del
Message Rules API
/cpaas/automation/inboundrules
Retrieves a message rules configuration list
get
Create a message rule configuration
post
/cpaas/automation/inboundrules/{messageRulesId}
Retrieves single message rule configuration
get
Update single message rule configuration
put
Delete single message rule configuration
del
Chat Presence API
/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
get
Profile API
/cpaas/profiles/export
Exports the result of a profile query in a formatted file for download
post
/cpaas/profiles/bulk
Deletes the requested profiles
del
Creates or updates the supplied profiles with the supplied data
patch
/cpaas/profiles/{id}
Retrieves a Profile
get
Updates or undeletes a Profile
put
Deletes a Profile
del
Patches a Profile
patch
/cpaas/profiles/{id}/optin
Set profile opt in for specified channels
put
Set profile opt in for specified channels
del
/cpaas/profiles/{id}/rels/primary/{linkedId}
Creates a relationship where the linked profile is the primary and this profile is a child
put
Deletes the profile's relationship to a primary profile
del
/cpaas/profiles/{id}/rels/link/{linkedId}
Creates a relationship where this profile is the primary and the linked profile is a child
put
Deletes the primary profile's relationship to a linked Profile
del
/apispaces/{apiSpaceId}/profiles/{id}/devices/{deviceId}
Removes device from profile and closes related opened sessions
del
/apispaces/{apiSpaceId}/profiles/devices/push/validation
Retrieves push capabilities summary
post
/cpaas/profiles
Query profiles
get
Creates a new Profile
post
/cpaas/profiles/optin
Gets default profiles opt in/out options for each channel in channel service
get
Set default profiles opt in/out options for each channel in channel service
put
Deprecated
Address books
Add contact to address book
post
Bulk import contacts in address book with merge option
post
Get modified contacts in address book since date
get
Get contacts from address book
get
Email Campaigns
Get all campaigns
get
Email Contacts
Create contact
post
Create contact with consent
post
Create contact with consent and preferences
post
Bulk import contacts collection
post
Bulk import contacts
post
Bulk import contacts in address book
post
Get contact import status
get
Get contact import report
get
Get contact import report faults
get
Update contact with consent and preferences
put
Delete contact
del
Get contact
get
Get contact with consent
get
Get contact address books
get
Get all contacts count
get
Get contacts
get
Get contacts created since date
get
Get modified contacts since date
get
Update contact with consent
put
Update contact
put
Facebook API
Facebook Meta Data Service
post
Insight and transactional data
Add transactional data to contact
post
Bulk add transactional data to contacts
post
Replace transactional data by key
post
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
get
Get transactional data collections
get
Delete transactional data collection for contact by id
del
Delete transactional data collection for contact by email
del
Delete transactional data by key
del
Empty transactional data collection
put
SOAP API
SOAP - Account
GetCurrentAccountInfo
EmptyRecycleBin
SOAP - Address books
CreateAddressBook
UpdateAddressBook
DeleteAddressBook
GetAddressBooks
GetAddressBookById
GetAddressBooksForCampaign
GetAddressBooksForContact
AddContactToAddressBook
ImportContactsToAddressBook
ImportContactsToAddressBookWithMergeOption
GetContactsInAddressBook
GetModifiedContactsInAddressBook
GetContactsScoreInAddressBook
GetContactsInAddressBookWithPreference
GetModifiedPreferencesOptInsByAddressBook
UnsubscribeContactFromAddressBook
GetUnsubscribedContactsInAddressBook
ResubscribeContactToAddressBook
ResubscribeContactToAddressBookWithNoChallenge
DeleteContactFromAddressBook
DeleteContactsFromAddressBook
DeleteAllContactsFromAddressBook
SOAP - Campaigns
CreateCampaign
CreateSplitTestCampaign (beta)
CopyCampaign
UpdateCampaign
SendCampaign
SendTimeOptimisedCampaign
DeleteCampaign
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
SOAP - Contacts
CreateContact
CreateContactWithConsent
CreateContactWithConsentAndPreferences
ImportContacts
UpdateContact
UpdateContactWithConsent
UpdateContactWithConsentAndPreferences
DeleteContact
GetContactByEmail
GetContactById
GetAllAccountContactsCount
GetContacts
GetModifiedContacts
GetNewContacts
GetContactImportProgress
GetContactImportReport
GetContactImportReportFaults
GetSuppressedContacts
GetUnsubscribedContacts
UnsubscribeContact
ResubscribeContact
ResubscribeContactWithNoChallenge
GetContactsScore
GetContactsScoreModifiedSinceDate
GetContactScoreByEmail
GetContactScoreByContactId
GetContactByIdWithConsent
GetContactByEmailWithConsent
GetContactsWithPreference
GetModifiedPreferenceOptIns
SOAP - Contact data fields
CreateDataField
DeleteDataField
GetDataFields
SOAP - Custom from addresses
GetCustomFromAddresses
SOAP - Document folders
CreateDocumentFolder
UploadDocument
GetDocumentFolders
GetDocuments
SOAP - Image folders
CreateImageFolder
UploadImage
GetImageFolders
GetImageFolderById
SOAP - Pages and forms
GetSurveys
GetSurveyById
GetSurveyFields
GetSurveyResponses
GetSurveyResponsesWithActivitySinceDate
GetSurveysWithActivitySinceDate
SOAP - Preferences
CreatePreference
SetPreferencesForContact
UpdatePreference
DeletePreference
GetPreferences
GetPreferencesForContact
GetPreferencesModifiedSinceDate
SOAP - Product recommendations
GetProductRecommendations
SOAP - Programs
CreateEnrolment
GetPrograms
GetProgramById
GetEnrolmentReport
GetEnrolmentsByStatus
GetEnrolmentById
SOAP - Segments
GetSegments
GetSegmentRefreshProgress
RefreshSegment
SOAP - Server time
GetServerTime
SOAP - SMS
SendSingleSmsMessage
CreateSMSCampaign
CopySMSCampaign
GetSMSCampaigns
GetSMSCampaign
UpdateSMSCampaign
DeleteSMSCampaign
SOAP - Templates
GetTemplates
CreateTemplate
UpdateTemplate
GetTemplateById
SOAP - Transactional email
SendTransactionalEmail
SendTransactionalEmailTriggeredCampaign
GetTransactionalEmailStatistics
SOAP - Transactional data
AddTransactionalData
ImportTransactionalData
ReplaceTransactionalDataByKey
DeleteTransactionalDataByContact
DeleteTransactionalDataByKey
GetTransactionalDataImportProgress
GetTransactionalDataImportReport
GetTransactionalDataByContact
GetTransactionalDataByKey
GetAccountScopedTransactionalData
Powered by
CreateCampaign
Ask AI
Creates a campaign
