/
DO
dotdigital
/
apiconnector.com
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 10h ago · Updated 3w ago
Details
Filter operations
ApiAccount
8
get
Gets a summary of information about the current status of the account.
get
Gets the UTC time as set on the server.
post
Creates an account. The ID of the newly returned account will be returned as the result of this call.
post
Creates Managed user for a given account id.
post
Adds an OAuth token to an account.
put
Changes a theme for an account.
post
Creates an API user for a given account ID. The username of the created user will be returned as the result of this call.
post
Empties the account's recycle bin.
ApiAddressBook
9
get
Gets a list by ID.
put
Updates a list.
delete
Deletes a list.
get
Gets all lists.
post
Creates a list.
get
Gets all private lists.
get
Gets all public lists.
get
Gets any lists that a contact is in.
get
Gets any lists that a campaign has ever been sent to.
ApiCampaign
13
get
Gets a campaign by ID.
put
Updates a given campaign.
get
Gets all campaigns.
post
Creates a campaign.
get
Gets all campaigns (with filters).
get
Gets all campaigns with additional information like type.
get
Gets any campaigns that have been sent to a list.
get
Gets all sent campaigns, which have had activity (e.g. clicks, opens) after a specified date.
post
Creates a split test campaign.
post
Copies a given campaign returning the new campaign.
delete
Deletes a campaign, and any associated reporting data. If the campaign is currently in use, or being sent to, this call will not be permitted.
get
Gets a campaign by ID with additional information like type and assigned tags
get
Gets the split test results of a given campaign.
ApiCampaignFromAddress
1
get
Gets all custom from addresses which can be used in a campaign.
ApiCampaignReporting
24
get
Gets a summary of reporting information for a specified campaign.
get
Gets a list of contacts who were sent a campaign, with their activity.
get
Gets a list of contacts who were sent a campaign, and retrieves only those contacts who showed activity (e.g. they clicked, opened) after a specified date.
get
Gets activity for a given contact and campaign.
get
Gets a list of campaign link clicks.
get
Gets a list of link clicks for a campaign after a specified date
get
Gets a list of campaign link clicks for a contact.
get
Gets a list of campaign opens.
get
Gets a list of opens for a campaign after a specified date
get
Gets a list of campaign opens for a contact.
get
Gets a list of page views for a campaign after a specified date.
get
Gets a list of page views for a contact.
get
Gets a list of campaign replies for a contact.
get
Gets campaign social bookmark views for a campaign.
get
Gets campaign social bookmark views for a contact.
get
Gets a list of ROI information for a campaign after the specified date.
get
Gets a list of ROI information for a contact.
get
Gets a list of contacts who hard bounced when sent a particular campaign.
get
Gets a list of campaign clicks with link groups
get
Gets a list of campaign clicks with link groups after a specified date
get
Gets a list of campaign clicks with link groups for a contact
get
Gets the revenue attributed to a specified campaign after a specified date.
get
Gets the revenue attributed to a specified campaign generated by a specified contact.
get
Gets all sent campaigns daily metrics for the specified date range.
ApiCampaignSend
3
post
Sends a specified campaign to one or more lists, segments or contacts at a specified time. Leave the list array empty to send to All Contacts.
post
Sends a specified campaign to one or more lists, segments or contacts at the most appropriate time based upon their previous open. Leave the list array empty to send to All Contacts.
get
Gets the send status using send ID.
ApiContact
54
get
Gets a list of suppressed contacts after a given date along with the reason for suppression.
get
Gets a list of unsubscribed contacts who unsubscribed after a given date.
get
Gets a list of modified contacts after a specified date.
get
Gets a list of created contacts after a specified date.
get
Gets a list of all contacts in the account.
post
Creates a contact.
get
Gets a contact by ID. Unsubscribed or suppressed contacts will not be retrieved.
put
Updates a contact.
delete
Deletes a contact.
get
Gets a contact by ID with consent records.
put
Updates a contact with consent records.
get
Gets a contact by email address.
get
Gets a contact by email address with consent records.
post
Creates a contact with consent records.
post
Creates a contact with consent and preference records.
put
Updates a contact with consent and preference records.
delete
Deletes a contact from a given list.
get
Gets a list of contacts in a given list.
post
Adds a contact to a given list.
delete
Deletes all contacts from a given list.
post
Deletes all contacts from a given list.
post
Deletes multiple contacts from a list. This will run in the background, and for larger lists may take some minutes to fully delete.
get
Gets the status of a previously started request to delete contacts from a list.
get
Gets a list of contacts who were modified since a given date, in a given list.
get
Gets a list of contacts who have unsubscribed from a given list.
post
Unsubscribes contact from account.
put
Suppresses a batch of contacts from account.
post
Unsubscribes contact from a given list.
post
Resubscribes a previously unsubscribed contact.
post
Resubscribes a previously unsubscribed contact with no challenge.
post
Resubscribes a previously unsubscribed contact to a given list.
post
Resubscribes a previously unsubscribed contact to a given list with no challenge.
get
/v2/contacts/transactional-data/{collectionName}
post
Adds a single piece of transactional data to a contact.
post
Adds multiple pieces of transactional data to contacts asynchronously, returning an identifier that can be used to check for import progress.
get
Gets the import status of a previously started transactional import.
get
Gets a report with statistics about what was successfully imported, and what was unable to be imported.
get
Gets a piece of transactional data by key.
post
Replaces a piece of transactional data by key (logicall equivalent to a delete and an insert).
delete
Deletes a piece of transactional data by key.
put
Removes all items from a transactional data collection.
get
Gets a list of all transactional data for a contact (100 most recent only).
delete
Deletes all transactional data for a contact.
get
Gets a list of all transactional data for a contact (100 most recent only).
delete
Deletes all transactional data for a contact.
get
Gets a list of account scoped transactional data for given collection
get
Gets a list of transactional data collections.
get
Gets a list of contact scoring data.
get
Gets a list of contact scoring data in specified list.
get
Gets a list of contact scoring data ordered by modified date.
get
Gets particular contact scoring data.
get
Gets particular contact scoring data.
get
Gets the total number of contacts in an account.
get
Gets a batch of contacts by ID or email address.
ApiContactImport
8
post
Bulk creates, or bulk updates, contacts. The ID of returned object can be used to query import progress.
post
Bulk creates, or bulk updates, contacts with merge options. The ID of returned object can be used to query import progress.
post
Bulk creates, or bulk updates, contacts. The ID of returned object can be used to query import progress.
post
Bulk creates, or bulk updates, contacts. The ID of returned object can be used to query import progress.
post
Bulk creates, or bulk updates, contacts with merge options. The ID of returned object can be used to query import progress.
get
Gets the import status of a previously started contact import.
get
Gets a report with statistics about what was successfully imported, and what was unable to be imported.
get
Gets all records that were not successfully imported.
ApiDataField
3
get
Lists the data fields within the account.
post
Creates a data field within the account.
delete
Deletes a data field within the account.
ApiDocument
7
get
Gets all uploaded documents.
post
Uploads a document into the specified folder.
get
Fetches the document folder tree structure.
get
Gets documents that are currently attached to a campaign.
post
Adds a document to a campaign as an attachment.
post
Creates a new document folder.
delete
Removes an attachment from a campaign.
ApiEcommerce
5
get
Returns the Retail KPI summaries for the specified date range.
post
Requests a refreshing of metric data.
get
Returns Retail KPI summaries across every data range.
get
Gets a KPI metric of a specified type over a specified date range.
get
Gets a list of all orders since a date.
ApiImage
4
get
Fetches the campaign image folder tree structure.
get
Gets an image folder by id.
post
Creates a new campaign image folder.
post
Uploads a new campaign image into the specified folder.
ApiPreference
18
get
Gets the preferences, as a tree structure.
post
Creates a new preference or a new preference category.
get
Gets an array of preferences that have been modified since the specified date.
put
Update the preference with the specified Id.
delete
Deletes the preference with the specified Id.
get
Gets a list of contacts subscribed to the specified preference.
get
Gets a list of contacts from a given list, subscribed to the specified preference.
put
Sets the subscribed preferences for a contact
put
Sets the subscribed preferences for a contact
get
Gets the preferences for the specified contact
put
Sets the subscribed preferences for a contact
get
Gets the preferences for the specified contact
put
Sets the subscribed preferences for a contact
get
Gets the preferences for the specified contact
get
Gets the preferences for the specified contact
get
Gets the subscriptions for the specified contact
get
Gets a list of contacts who have opted in to a preference since the specified date
get
Gets a list of contacts, from a given list, who have opted in to a preference, since the specified date
ApiProductRecommendations
1
get
Gets all product recommendations for the account.
ApiProgram
6
get
Gets a program by id.
get
Gets all programs.
get
Gets enrolments by status.
get
Gets an enrolment by id.
get
Gets all contacts that were not successfully enrolled, by enrolment ID.
post
Creates an enrolment.
ApiSegment
3
get
Gets the refresh progress for a segment.
post
Refreshes a segment by ID.
get
Gets all segments.
ApiSms
7
post
Sends a single SMS message.
get
Gets SMS Campaigns.
post
Creates an SMS campaign.
get
Gets SMS campaign by Id.
put
Updates an SMS campaign.
delete
Deletes an SMS campaign.
post
Copies an SMS campaign.
ApiSurvey
6
get
Gets a list of all surveys in the account.
get
Gets a list of surveys in the account that have changed since the specified date.
get
Gets a single survey by its ID.
get
Gets a list of survey pages, each containing a list of the fields on that page.
get
Gets a list of all responses for a given survey.
get
Gets a list of responses that have changed since the specified date.
ApiTemplate
4
get
Gets list of all templates.
post
Creates a template.
get
Gets a template by ID.
put
Updates a template.
ApiTransactionalEmail
6
post
Sends a transactional email. If sending to multiple recipients, please separate addresses with a comma.
post
Sends one or more transactional emails. If sending to multiple recipients, please separate addresses with a comma.
post
Sends a transactional email with content taken from a triggered campaign. If sending to multiple recipients, please separate addresses with a comma.
post
Sends one or more transactional emails with content for each taken from a triggered campaign. If sending to multiple recipients, please separate addresses with a comma.
get
Gets aggregated transactional email statistics.
get
/v2/campaigns/{campaignId}/prepared-for-transactional-email/{email}
ApiAccount
Gets a summary of information about the current status of the account.
get
/v2/account-info
Response
ApiAccount
required
id
integer
properties
ApiAccountProperty[]
required
Changes