Available Dotdigital APIs

Account info

Get account information

X

Accounts

Empty recycle bin

X

Address books

Create list

X

Get lists

X

Delete list

X

Update list

X

Get list

X

Get private lists

X

Get public lists

X

Get unsubscribed from list since date

X

Unsubscribe contact from list

X

Resubscribe contact to list

X

Resubscribe contact to list with no challenge

X

Delete contact from list

X

Delete contacts from list

X

Delete all contacts from list

X

Get contacts opted into a preference and an address book

X

Get contacts with modified preference opt in in address book since date

X

Get scoring for contacts in address book

X

Get campaigns sent to address book or segment

X

Add contact to address book (Deprecated)

X

Get contacts from address book (Deprecated)

X

Bulk import contacts in address book with merge option

X

API spaces

Facebook metadata service

X

Remove device from profile and close related opened sessions

X

Retrieve push capabilities summary

X

App messaging

Retrieve conversation message analytics

X

Retrieve session analytics

X

Bulk validation

List bulk validation jobs

X

Bulk validate numbers

X

Get bulk job details

X

Get bulk job results

X

Campaigns

Create campaign

X

Get all campaigns (Deprecated)

X

Create split test campaign

X

Update campaign

X

Delete campaign

X

Get campaign

X

Copy campaign

X

Send campaign

X

Send time optimised campaign

X

Get campaign send status

X

Add campaign attachment

X

Get campaign attachments

X

Remove campaign attachment

X

Get all campaigns (with filters)

X

Get campaign with details

X

Get campaign summary

X

Get campaign opens

X

Get campaign opens for a contact

X

Get campaign activity for a contact

X

Get campaign activity since date

X

Get campaign clicks

X

Get campaign clicks and link groups

X

Get campaign clicks since date

X

Get campaign clicks and link groups since date

X

Get campaign opens since date

X

Get campaign activity

X

Get campaign address books

X

Get campaign clicks for a contact

X

Get campaign contact clicks and link groups

X

Get campaigns with activity since date

X

Get campaign page views for a contact

X

Get campaign page views since date

X

Get campaign replies for a contact

X

Get campaign ROI activity for a contact

X

Get campaign ROI activity since date

X

Get campaign social bookmark views

X

Get campaign social bookmark views for a contact

X

Get campaign hard bouncers

X

Get campaign split test results

X

Get campaign revenue since date

X

Get campaign revenue for contact

X

Chat

Retrieve chat analytics

X

Chat

Retrieve live chat analytics

X

Contacts

Unsubscribe contact

X

Bulk suppress contacts

X

Resubscribe contact

X

Resubscribe contact with no challenge

X

Get suppressed contacts since date

X

Get subscriptions for contact

X

Get unsubscribed contacts since date

X

Set preferences for contact

X

Get preferences for contact

X

Get contacts opted into a preference

X

Get contacts with modified preference opt in since date

X

Get scoring for contacts

X

Get scoring modified since date for contacts

X

Get scoring for contact

X

Create contact (Deprecated)

X

Get contacts (Deprecated)

X

Create contact with consent and preferences (Deprecated)

X

Update contact with consent and preferences (Deprecated)

X

Update contact (Deprecated)

X

Get contact (Deprecated)

X

Delete transactional data collection for contact by ID

X

Get contact by email

X

Get contact by email with consent

X

Get scoring for contact by email

X

Get contacts based on your criteria

X

Create a contact

X

Delete multiple contacts

X

Retrieve the status of a delete contacts job

X

Import contact collection

X

Retrieve the status of a contacts import request

X

Retrieve a contact by an identifier

X

Replace a contact

X

Delete a contact using a specific identifier

X

Import a single contact

X

CPaaS

Retrieve a chat

X

Update a chat

X

Delete a chat

X

Assign a chat

X

Close a chat

X

Change the channel for an existing chat

X

Send a form to a chat

X

Retrieve a list of chats

X

Create a new chat

X

Indicate that the caller is typing in this chat

X

Indicate that the caller has stopped typing in this chat

X

Retrieve the chat participants

X

Retrieve the chat configuration for an apispace

X

Retrieve the members of a team

X

Remove the config for a team

X

Update the app messaging config for a team

X

Remove the app messaging config for a team

X

Update general settings for a team

X

Remove the settings for a team

X

Retrieve a chat's events

X

Retrieve a chat's messages from an point (event) in time and works backwards

X

Send a message to chat

X

Post message update back

X

Retrieve the presence for a list of agent's profileids

X

Retrieve the presence for a list of user's profileids

X

Upload a file

X

Retrieve a file

X

Delete a file

X

Retrieve a conversation

X

Update a conversation

X

Delete a conversation

X

Retrieve a list of conversations

X

Create a new conversation

X

Indicate that the caller is typing in this conversation

X

Indicate that the caller has stopped typing in this conversation

X

Retrieve the conversation participants

X

Add a list of participants to a conversation

X

Delete a list of participants from a conversation

X

Retrieve a conversation's events

X

Retrieve a conversation's messages from an point (event) in time and works backwards

X

Send a message to conversation

X

Post message update back

X

Retrieve message history for the specified profile

X

Retrieve a message rules configuration list

X

Create a message rule configuration

X

Retrieve single message rule configuration

X

Update single message rule configuration

X

Delete single message rule configuration

X

Export the result of a profile query in a formatted file for download

X

Delete the requested profiles

X

Create or update the supplied profiles with the supplied data

X

Retrieve a profile

X

Update or undelete a profile

X

Delete a profile

X

Patch a profile

X

Set profile opt in for specified channels

X

Set profile opt in for specified channels

X

Create a relationship where the linked profile is the primary and this profile is a child

X

Delete the profile's relationship to a primary profile

X

Create a relationship where this profile is the primary and the linked profile is a child

X

Delete the primary profile's relationship to a linked profile

X

Query profiles

X

Create a new profile

X

Get default profiles opt in/out options for each channel in channel service

X

Set default profiles opt in/out options for each channel in channel service

X

Get a token that can be used to start an anonymous session

X

Retrieve details about a session

X

End a session

X

Retrieve a list of all available templates

X

Create a template

X

Retrieve a template

X

Update a template

X

Delete a template

X

Custom from addresses

Get custom from addresses

X

Custom identifiers

Get all custom identifiers

X

Create a custom identifier

X

Delete a custom identifier by name

X

Data fields

Create contact data field

X

Get contact data fields

X

Delete contact data field

X

Data firehose

Update configuration

X

Delete configuration

X

Get configuration

X

Update configuration status

X

Add configuration

X

Document folders

Create document folder

X

Get document folders

X

Get documents in folder

X

Upload document

X

Ecommerce

Get orders since date

X

Email

Send transactional email

X

Send batch transactional email

X

Send transactional email using a triggered campaign

X

Send batch transactional email using a triggered campaign

X

Get transactional email statistics

X

Export events

Retrieve events

X

Image folders

Create image folder

X

Get image folders by ID

X

Upload campaign image

X

Get image folders

X

Import events

Import a collection of events

X

Insight data

Bulk imports insight data

X

Retrieve the status of a insight data import request

X

Retrieve the status of an asynchronous request

X

Lists all insight data collections

X

Create an insight data collection

X

Delete an insight data collection

X

Empties an insight data collection

X

Get the JSON schema for an insight data collection

X

List account insight data collections

X

Retrieve records from an accounts insight data collection

X

Retrieve single record from an account insight data collection

X

Upsert record into an account insight data collection

X

Delete record from an account insight data collection

X

Retrieve data for contact scoped insight data collection

X

List insight data collections for a contact

X

Retrieve records for a contact from insight data collection

X

Empty insight data collection for a contact

X

Retrieve insight data record for a contact

X

Upsert record into insight data collection for a contact

X

Delete record from insight data collection for a contact

X

Large objects

Retrieve large object

X

Marketing emails

Send marketing email

X

Send batch marketing emails

X

Messaging

Retrieve message analytics

X

Retrieve message metrics

X

Omnichannel

Post a status for a message

X

Retrieve the current state of a specific message

X

Delete a message

X

Patch a message

X

Send a new message

X

Send a batch of new messages

X

Post an inbound message

X

Post a status for an inbound

X

Preferences

Create preference

X

Get preferences

X

Update preference

X

Delete preference

X

Get modified preferences since date

X

Products

Get all product recommendations

X

Programs

Create program enrolment

X

Get programs

X

Get program by ID

X

Get program enrolment report faults

X

Get program enrolment

X

Get program enrolments by status

X

Segments

Get segments

X

Refresh segment

X

Get refresh progress for segment

X

Server time

Get server time

X

Single number

Validate a single number

X

SMS

Retrieve URL tracking analytics

X

Retrieve SMS verify analytics

X

Retrieve inbound SMS analytics

X

Retrieve outbound SMS analytics

X

Create SMS campaign

X

Get SMS campaigns

X

Copy SMS campaign

X

Get SMS campaign

X

Update SMS campaign

X

Delete SMS campaign

X

Get SMS phone numbers

X

Get SMS shortcodes

X

Get SMS keywords

X

SMS messages

Send SMS message

X

Subscriptions

List subscriptions

X

Create subscription

X

Get subscription

X

Update subscription

X

Delete subscription

X

Surveys

Get forms

X

Get form by ID

X

Get forms with activity since date

X

Get form fields

X

Get form responses

X

Get form responses with activity since date

X

Templates

Create template

X

Get templates

X

Get template by ID

X

Update template

X

Transactional data

Get account scoped transactional data (Deprecated)

X

Webhooks

Get webhooks

X

Create webhook

X

Retrieve available webhook events

X

Get event templates

X

Retrieve webhook configuration

X

Update webhook configuration

X

Delete webhook

X

WhatsApp

Retrieve WhatsApp conversation analytics

X

Retrieve WhatsApp business initiated conversation analytics for the last 24 hours (daily message usage)

X

WhatsApp configurations

Get WhatsApp configuration for API space

X

Create WhatsApp configuration

X

WhatsApp numbers

Get WhatsApp number

X

Remove WhatsApp number

X

Registers WhatsApp number

X

WhatsApp templates

Get WhatsApp templates

X

Get WhatsApp template

X