Dotdigital MCP connector

• List List all Dotdigital campaigns List all dotdigital campaigns. Returns: id, name, subject, fromName, fromAddress, htmlContent, plainTextContent, replyAction, replyToAddress, isSplitTest, status. Max 1000 records per page.
• Create Create a Dotdigital campaign Create a new dotdigital campaign. Returns: id, name, subject, fromName, fromAddress, htmlContent, plainTextContent, replyAction, replyToAddress, isSplitTest, status, type. Required: name, subject, fromName, htmlContent, plainTextContent.
• Get Get single Dotdigital campaign by ID Get a single dotdigital campaign by id. Returns: id, examples, name. Required: id.
• Update Update a Dotdigital campaign by ID Update a dotdigital campaign by id. Returns: id, subject, fromName, fromAddress, htmlContent, plainTextContent, replyAction, replyToAddress, isSplitTest, status, examples, name. Required: id.
• Delete Delete a Dotdigital campaign by ID Delete a dotdigital campaign by id. Returns an empty 204 response on success. Required: id.
• Create Create a Dotdigital campaigns split test Create an email split test campaign in dotdigital by providing a campaign name plus content arrays that define one or more variations. Returns: id, name, subjects, fromNames, fromAddresses, htmlContents, plainTextContents, replyAction, replyToAddress, customReplyToAddress, status. Required: name, plainTextContents. Maximum 10 variations; any field being split-tested must have the same number of…
• Create Create a Dotdigital campaign copy Copy a dotdigital campaign, returning the newly created duplicate. Returns: id, examples. Required: campaign_id.
• Create Create a Dotdigital campaigns send Send a dotdigital campaign to one or more address books, segments, or contacts, either immediately or scheduled for a future date. Returns: id, campaignId, addressBookIds, contactIds, sendDate, splitTestOptions, status.
• Get Get single Dotdigital campaigns send by ID Get the status of a dotdigital campaign send by its send ID (GUID). Returns: id, campaignId, addressBookIds, contactIds, sendDate, splitTestOptions, status. Required: id.
• Create Create a Dotdigital campaigns send time optimised Send a dotdigital campaign to one or more address books or contacts at the optimised time based on recipients' previous opens. Returns: id, campaignId, addressBookIds, contactIds, sendDate, splitTestOptions, status. Required: campaignID.
• Delete Delete a Dotdigital campaign attachment by ID Remove a document attachment from a dotdigital campaign. Returns an empty 204 response on success. Required: campaign_id, id.
• List List all Dotdigital campaign attachments List documents currently attached to a dotdigital campaign. Returns: id, name, fileName, fileSize, dateCreated, dateModified. Required: campaign_id.
• Create Create a Dotdigital campaign attachment Add a document to a dotdigital campaign as an attachment. Returns the attached document object including id, name, fileName, fileSize, dateCreated, and dateModified. Required: campaign_id.
• List List all Dotdigital campaigns filtereds List dotdigital campaigns with optional filters for type, tags, status, sent date, and scheduled date range. Returns: id, type. Max 1000 records per request.
• List List all Dotdigital campaign with details Get a dotdigital campaign with all its details by campaign id. Returns: id, type, examples. Required: campaign_id.
• List List all Dotdigital campaign summaries Get a summary of reporting information for a specified dotdigital campaign. Returns: examples. Required: campaign_id.
• List List all Dotdigital campaign opens List campaign opens for a specific dotdigital campaign. Returns: contactId, email, mailClient, mailClientVersion, ipAddress, userAgent, isHtml, isForward, dateOpened. Required: campaign_id.
• List List all Dotdigital activitie opens List campaign opens for a specific contact in dotdigital. Returns: contactId, email, mailClient, mailClientVersion, ipAddress, userAgent, isHtml, isForward, dateOpened. Required: campaign_id, contact_id.
• List List all Dotdigital campaign activities List dotdigital campaign activities for all contacts sent a campaign. Returns: contactId, email, numOpens, numPageViews, numClicks, numForwards, numEstimatedForwards, numReplies, dateSent, dateFirstOpened, dateLastOpened, firstOpenIp, unsubscribed, softBounced, hardBounced. Required: campaign_id.
• Get Get single Dotdigital campaign activity by ID Get a single dotdigital campaign activity by id. Returns: contactId, email, numOpens, numPageViews, numClicks, numForwards, numEstimatedForwards, numReplies, dateSent, dateFirstOpened, dateLastOpened, firstOpenIp, unsubscribed, softBounced, hardBounced. Required: campaign_id, id.
• List List all Dotdigital activities since dates List dotdigital campaign activity since a specified date for contacts who showed activity (opens, clicks, forwards). Returns: examples. Required: campaign_id, date. Max 1000 records per page.
• List List all Dotdigital campaign clicks List link clicks for a dotdigital campaign. Returns: contactId, email, url, ipAddress, userAgent, dateClicked, keyword. Required: campaign_id.
• List List all Dotdigital campaign clicks with groups List campaign link clicks with assigned link groups for a dotdigital campaign. Returns: contactId, email, url, ipAddress, userAgent, dateClicked, keyword, groups. Required: campaign_id. Max 1000 records per page.
• List List all Dotdigital clicks since dates List link clicks for a dotdigital campaign since a specified date. Returns: contactId, email, url, ipAddress, userAgent, dateClicked, keyword. Required: campaign_id, date (ISO 8601). Max 1000 records per request.
• List List all Dotdigital clicks with groups since dates List link clicks for a dotdigital campaign with assigned link groups, starting from a specified date. Returns: contactId, email, url, ipAddress, userAgent, dateClicked, keyword, groups. Required: campaign_id, date. The date must be in ISO 8601 format.
• List List all Dotdigital opens since dates List campaign opens in dotdigital recorded since a specified date. Returns: contactId, email, mailClient, mailClientVersion, ipAddress, userAgent, isHtml, isForward, dateOpened. Required: campaign_id, date.
• List List all Dotdigital campaign address books List address books and segments that a dotdigital campaign has ever been sent to. Returns: id, name, visibility, contacts. Required: campaign_id.
• List List all Dotdigital activitie clicks List campaign link clicks for a contact in dotdigital. Returns: contactId, email, url, ipAddress, userAgent, dateClicked, keyword. Required: campaign_id, contact_id. Max 1000 records per request.
• List List all Dotdigital activitie clicks with groups List dotdigital campaign link clicks with assigned link groups for a specific contact. Returns: contactId, email, url, ipAddress, userAgent, dateClicked, keyword, groups. Required: campaign_id, contact_id.
• List List all Dotdigital campaigns with activity sinces List dotdigital sent campaigns that have had activity (e.g. clicks, opens) after a specified date. Returns: id, name, subject, fromName, fromAddress, htmlContent, plainTextContent, replyAction, replyToAddress, isSplitTest, status. Required: date in ISO 8601 format.
• List List all Dotdigital activitie page views List page views for a specific campaign contact in dotdigital. Returns: contactId, email, url, dateViewed. Required: campaign_id, contact_id. Max 1000 records per page.
• List List all Dotdigital page views since dates List page views for a dotdigital campaign since a specified date. Returns: url. Required: campaign_id, date.
• List List all Dotdigital activitie replies List campaign replies for a specific contact in dotdigital. Returns: contactId, email, fromAddress, toAddress, subject, message, isHtml, dateReplied, replyType. Required: campaign_id, contact_id.
• List List all Dotdigital activitie roi details List campaign ROI activity details for a specific contact in dotdigital. Returns: contactId, email, markerName, dataType, value, dateEntered. Required: campaign_id, contact_id.
• List List all Dotdigital roi details since dates List dotdigital campaign ROI activity records since a specified date. Returns: contactId, email, markerName, dataType, value, dateEntered. Required: campaign_id, date.
• List List all Dotdigital campaign social bookmark views List social bookmark views for a dotdigital campaign. Returns: contactId, email, bookmarkName, numViews. Required: campaign_id.
• List List all Dotdigital activitie social bookmark views List social bookmark views for a specific contact within a dotdigital campaign. Returns: contactId, email, bookmarkName, numViews. Required: campaign_id, contact_id.
• List List all Dotdigital campaign hard bouncing contacts List contacts who hard bounced when sent a particular dotdigital campaign. Returns: id, email, optInType, emailType, dataFields, status. Required: campaign_id.
• List List all Dotdigital campaign split tests Get the split test results for a dotdigital campaign by campaign_id. Returns the split test results including versions with subjectLine, fromName, fromAddress, version, winningVersion, resultsActual, resultsPercentage, and splitTestWinnerMetric. Required: campaign_id.
• List List all Dotdigital custom from addresses List custom from addresses available for use in dotdigital campaigns. Returns: id, email, _links, _items.
• List List all Dotdigital revenue since dates Get campaign revenue data collated since a specified date in dotdigital. Returns: campaignID, dateSent, currency, revenue, numOrders, conversionRate. Required: campaign_id, date.
• List List all Dotdigital activitie revenues Get campaign revenue for a specific contact in dotdigital. Returns: campaignID, dateSent, currency, revenue, numOrders, conversionRate. Required: campaign_id, contact_id.
• List List all Dotdigital campaigns metrics List dotdigital campaign metrics between two UTC dates for all sent campaigns with activity. Returns: campaignId, campaignName, campaignType, sent, delivered, uniqueOpens, clicks, revenue, and percentage metrics per campaign. Required: startDate, endDate. Up to 1000 records per request via the select parameter.
• List List all Dotdigital ecommerce orders List dotdigital ecommerce orders placed since a specified date. Returns each order's id, email, contactId, items, orderTotal, orderDate, currency, and delivery/billing address details. Required: fromDate (ISO 8601 date; time component is ignored). Max 1000 records per page.
• List List all Dotdigital segments List all segments in dotdigital. Returns each segment's id, name, and the number of contacts it contains. No required parameters.
• Get Get single Dotdigital segments refresh by ID Get the refresh progress for a dotdigital segment by id. Returns: id, status. Required: id. The source documents only these two fields for this endpoint.
• Create Create a Dotdigital segments refresh Trigger a refresh of a dotdigital segment. Returns: id, status. The response is asynchronous (202 Accepted). Required: refresh_id.
• Create Create a Dotdigital programs enrolment Create a program enrolment in dotdigital by enrolling contacts and/or address books into a program. Processing happens asynchronously; use the returned id to track progress. Returns: id, programId, status, dateCreated, contacts, addressBooks. Required: programId. At least one contact or address book must be supplied; contacts are limited to 25 and address books to 10.
• Get Get single Dotdigital programs enrolment by ID Get a single dotdigital program enrolment by id. Returns: id, programId, status, dateCreated, contacts, addressBooks. Required: id.
• List List all Dotdigital programs List all dotdigital programs in your account. Returns: id, name, status, dateCreated. Select up to 1000 records per request.
• Get Get single Dotdigital program by ID Get a single dotdigital program by its numeric id. Returns: id, name, status, dateCreated. Required: id.
• List List all Dotdigital enrolment report faults List dotdigital contacts that were not successfully enrolled in a program enrolment. Returns a CSV report with columns: Id, Email, TelephoneNumber, Reason. Required: enrolment_id. The report is unavailable while the enrolment is still processing.
• List List all Dotdigital sms campaigns List SMS campaigns in dotdigital. Returns each campaign with id, name, message, sendingIdentity, sendingIdentityId, toggleShortLinks, and status. Max 1000 records per page.
• Create Create a Dotdigital sms campaign Create a new SMS campaign in dotdigital. Returns the created campaign including id, name, message, sendingIdentity, sendingIdentityId, toggleShortLinks, and status. Required: name, message.
• Get Get single Dotdigital sms campaign by ID Get a single SMS campaign by id in dotdigital. Returns: id, name, message, sendingIdentity, sendingIdentityId, toggleShortLinks, status. Required: id.
• Update Update a Dotdigital sms campaign by ID Update an existing SMS campaign in dotdigital, as long as it has not been sent. Returns: id, name, message, sendingIdentity, sendingIdentityId, toggleShortLinks, status. Required: id, name, message.
• Delete Delete a Dotdigital sms campaign by ID Delete an SMS campaign by id in dotdigital. Returns an empty 200 response on success. Required: id.
• Create Create a Dotdigital campaigns copy Create a copy of an existing SMS campaign in dotdigital. Returns: id, name, message, sendingIdentity, sendingIdentityId, toggleShortLinks, status. Required: campaignId, copyName. Copy name limited to 255 characters; deleted campaigns cannot be copied.
• Create Create a Dotdigital sms messages send to Send a single SMS message to a dotdigital contact by telephone number in E.164 format. Returns an empty 204 response on success. Required: telephone_number, message.
• Create Create a Dotdigital email Send a transactional email to one or more recipients in dotdigital. Returns an empty 200 response on success. Required: toAddresses, subject. Max 100 recipients per address field; attachments up to 15 MB each.
• Create Create a Dotdigital email batch Send batch transactional emails to multiple recipients in dotdigital. Returns an array of results per email with index, failureCode, and failureReason. Required: toAddresses and subject per email item. Max 100 recipients per address field; metadata max 1500 characters; attachments max 15 MB.
• Create Create a Dotdigital email triggered campaign Send a transactional email in dotdigital using a triggered campaign with recipient addresses, personalization values, and optional attachments. Returns an empty 200 response on success. Required: toAddresses, campaignId. Max 100 recipients per address field; attachments up to 15 MB each; metadata limited to 1500 characters.
• Create Create a Dotdigital triggered campaign batch Send batch transactional emails in dotdigital using triggered campaigns. Returns an array of per-email results including index, failureCode, and failureReason (failure fields appear only for failed items). Required: a JSON array body where each item must include toAddresses and campaignId. Max 100 addresses per email; attachments up to 15 MB each; metadata limited to 1500 characters.
• List List all Dotdigital stats since dates List dotdigital transactional email reporting statistics for a specified time period. Returns: startDate, endDate, numSent, numDelivered, numOpens, numClicks, numIspComplaints, numBounces. Required: date.
• List List all Dotdigital image folders List dotdigital image folders as a tree structure. Returns each folder with id, name, and childFolders (nested recursively).
• Get Get single Dotdigital image folder by ID Get a single dotdigital image folder by id. Returns: id, name, childFolders. Required: id. The root folder id is 0.
• Create Create a Dotdigital image folder Create a new image folder within an existing dotdigital image folder. Returns: id, name, childFolders. Required: image_folder_id (parent folder id, root is 0) and name (max 20 characters, alphanumeric with hyphens and underscores only).
• List List all Dotdigital image folder images List images in a dotdigital image folder. Returns: url, filename, mimeType, sizeInBytes, widthInPixels, heightInPixels, contentTags. Required: image_folder_id.
• Create Create a Dotdigital image folder image Upload a new image to a dotdigital image folder using a JSON body with Base64-encoded file data. Returns: id, name, path. Required: image_folder_id, fileName, data. Permitted file types: GIF, JPEG, PNG.
• List List all Dotdigital contacts scores List contact scoring for all contacts in a dotdigital account. Returns: contactId, email, dateModified, scoreLabel, score, engagement, suitability. The select parameter controls how many records to retrieve (1–1000, defaults to 1000).
• List List all Dotdigital score modified sinces List dotdigital contacts whose contact scoring data has been modified since a given UTC date-time. Returns: contactId, email, dateModified, scoreLabel, score, engagement, suitability. Required: date.
• List List all Dotdigital contact scores Get contact scoring information for a specific dotdigital contact. Returns: contactId, email, dateModified, scoreLabel, score, engagement, suitability. Required: contact_identifier (either the contact's email address or numeric contact ID).
• List List all Dotdigital products recommendations List all product recommendations in dotdigital. Returns: id, dateLastRefreshed, dateModified, dateLastUsed, name, type, status, fallbackRecommendationId, revenue.
• List List all Dotdigital account infos Get a summary of the current dotdigital account status, including email and SMS send credits, premium wallet balance, API call usage in the last hour and remaining, managed users list, account name, main email, main mobile number, API locale, API endpoint, currency code, campaign email MTA pool, clock display setting, and IANA timezone. Returns: id, properties.
• List List all Dotdigital server times Get the UTC server time as set on dotdigital's servers. Returns the current date and time in ISO-8601 format (e.g., 2021-09-24 09:21:55.661571+00:00).
• Create Create a Dotdigital accounts empty recycle bin Empty the recycle bin in dotdigital, permanently deleting everything in it. Returns an empty 202 response on success.
• List List all Dotdigital templates List all email campaign templates in dotdigital. Returns: id, name, subject, fromName, htmlContent, plainTextContent, replyAction, replyToAddress.
• Create Create a Dotdigital template Create a new email campaign template in dotdigital. Returns the created template including id, name, subject, fromName, htmlContent, plainTextContent, replyAction, and replyToAddress. Required: name, subject, fromName, htmlContent, plainTextContent.
• Get Get single Dotdigital template by ID Get a single email campaign template in dotdigital by id. Returns: id, example, name. Required: id.
• Update Update a Dotdigital template by ID Update an email campaign template in dotdigital by id. Returns the updated template including id, name, subject, fromName, htmlContent, plainTextContent, replyAction, and replyToAddress. Required: id, name, subject, fromName, htmlContent, plainTextContent.
• List List all Dotdigital data fields List all contact data fields in the dotdigital account. Returns: name, type, visibility, defaultValue, _links, _items.
• Create Create a Dotdigital data field Create a contact data field in the dotdigital account. Returns: name, type, visibility, defaultValue. Required: name, type. The field name must be alphanumeric (hyphens and underscores allowed) with a maximum of 20 characters.
• Delete Dotdigital data fields bulk delete Delete a contact data field in the dotdigital account by name. Returns: dependencies, result. Required: name.
• Create Create a Dotdigital document folder Create a new document folder inside an existing dotdigital folder. Returns: id, name, childFolders. Required: document_folder_id, name. The folder name must be up to 20 characters, alphanumeric only with hyphens and underscores permitted.
• List List all Dotdigital document folders List dotdigital document folders as a tree structure. Returns each root folder with id, name, and nested childFolders.
• List List all Dotdigital document folder documents List all uploaded documents in a dotdigital document folder. Returns: id, name, fileName, fileSize, dateCreated, dateModified. Required: document_folder_id.
• Create Create a Dotdigital document folder document Upload a document to a dotdigital document folder. Returns: id, name, childFolders. Required: document_folder_id. Only one file may be uploaded per call.
• Get Get single Dotdigital contacts deletion by ID Get the progress of a bulk contact deletion in dotdigital by deletion request id. Returns: Id, Status. Required: id (the deletion request id returned from a previous bulk contact deletion call).
• List List all Dotdigital contacts List dotdigital contacts with optional filtering by created date, modified date, list, or segment, and control which data fields and associated data sets are returned. Returns each contact's id, email, optInType, emailType, dataFields, and status. Data is returned in ascending order. The ~created and ~modified filters are mutually exclusive; the ~listId and ~segmentId filters are mutually…
• Create Create a Dotdigital contact Create a contact in dotdigital; fails with a 409 if the contact's identifiers already exist in the account. Returns: id, email, optInType, emailType, dataFields, status. Required: email.
• Update Update a Dotdigital contact by ID Replace a dotdigital contact entirely by identifier and value. Returns: id, email, optInType, emailType, dataFields, status. Required: identifier, id. This replaces the entire contact; use PATCH to update select fields only. It is not possible to modify the contactId field.
• Delete Delete a Dotdigital contact by ID Delete a dotdigital contact by identifier type and value. Returns an empty 204 response on success. Required: identifier, id.
• Get Get single Dotdigital contact by ID Get a dotdigital contact's details by identifier type and value. Returns: id, email, optInType, emailType, dataFields, status. Required: identifier, id.
• Update Dotdigital contacts partial update Import a single contact in dotdigital by identifier type and value, updating an existing contact with only the fields passed or creating a new one if not found. Returns: id, email, optInType, emailType, dataFields, status. Required: identifier, id. The merge_option parameter controls how new data merges into existing contacts (defaults to overwrite). It is not possible to modify the contactId…
• Create Create a Dotdigital contacts with consent Create or update a dotdigital contact along with their consent information. Returns: contact, consentFields. Required: contact (with email).
• Create Create a Dotdigital contacts with consent and preference Create or update a dotdigital contact with consent data and marketing preferences. Returns the created contact (id, email, optInType, emailType, status), consentFields, and preferences with opt-in states. Required: contact (with email).
• Create Create a Dotdigital contacts import collection Bulk create or update dotdigital contacts from a JSON collection, optionally adding them to address books. Returns: id, status. Required: addressBookIds and contacts. The import is asynchronous — the response status will be 'NotFinished' until processing completes.
• Create Create a Dotdigital contacts import Bulk import contacts in dotdigital from a base64-encoded file. Returns: id, status. Required: filename, data.
• Get Get single Dotdigital contacts import by ID Get the status of a dotdigital contacts import request by id. Returns: id, status. Required: id.
• Update Dotdigital contacts imports bulk update Import a collection of contacts in dotdigital, creating new contacts and updating existing ones. Async operation — poll the get import status endpoint for completion. Returns: id. Required: contacts.
• List List all Dotdigital reports Get a dotdigital contact import report with statistics on successfully and unsuccessfully imported contacts. Returns: newContacts, updatedContacts, globallySuppressed, invalidEntries, duplicateEmails, blocked, unsubscribed, hardBounced, softBounced, ispComplaints, mailBlocked, domainSuppressed, pendingDoubleOptin, failures, suppressedContacts. Required: import_id.
• List List all Dotdigital report faults List contact import records that were not successfully imported in dotdigital. Returns each faulted record with Reason, email, firstname, fullname, gender, lastname, and postcode. Required: import_id.
• Update Dotdigital contact with consent and preferences bulk update Update a dotdigital contact by id with consent information and/or marketing preferences. Returns: contact (id, email, status), consentFields, preferences (id, publicName, isOptedIn). Required: id, contact (email is required within contact).
• List List all Dotdigital contact with consents Get a dotdigital contact with their consent information by contact identifier (id or email address). Returns the contact object including id, email, optInType, emailType, dataFields, status, and the consentFields array. Required: contact_identifier.
• Update Dotdigital contact with consents bulk update Update a dotdigital contact by id with consent information. Returns the updated contact object including id, email, optInType, emailType, dataFields, status, and the consentFields array. Required: id, contact (with email).
• List List all Dotdigital contact address books List dotdigital address books that a contact belongs to. Returns: id, name, visibility, contacts. Required: contact_id.
• List List all Dotdigital contacts counts Get the total number of contacts in the dotdigital account. Returns: a single integer representing the count of all contacts (e.g., 42525). No required parameters.
• List List all Dotdigital contacts created sinces List dotdigital contacts created after a specified date. Returns each contact's id, email, optInType, emailType, dataFields, and status. Required: date.
• List List all Dotdigital contacts modified sinces List dotdigital contacts modified since a specified date within an address book. Returns: id, email, optInType, emailType, dataFields, status. Required: address_book_id, date. The select parameter accepts values between 1 and 1000.
• Create Create a Dotdigital contacts transactional data Add a single piece of transactional/insight data to a dotdigital contact or account in a named collection. Returns: key, contactIdentifier, json. Required: collection_name, key, contactIdentifier, json.
• Delete Delete a Dotdigital contacts transactional data by ID Delete a piece of transactional data from a dotdigital contact by key within a named collection. Returns an empty 204 response on success. Required: collection_name, id.
• Update Update a Dotdigital contacts transactional data by ID Replace a piece of dotdigital transactional/insight data by key within a collection. Returns: _links, _items. Required: collection_name, id, json.
• Get Get single Dotdigital contacts transactional data by ID Get a single piece of dotdigital transactional/insight data by key within a collection. Returns: _links, _items. Required: collection_name, id.
• Create Create a Dotdigital transactional data import Bulk add transactional/insight data to contacts in a dotdigital transactional data collection asynchronously. Returns: id, status. Required: collection_name, and a body array of insight data items each containing key, contactIdentifier, and json. Poll the returned id via the get method to check import status.
• Get Get single Dotdigital transactional data import by ID Get the import status of a previously started dotdigital transactional data import by id. Returns: id, status. Required: id.
• List List all Dotdigital contact transactional datas List transactional data records for a dotdigital contact in a specific collection. Returns up to 100 records sorted by transactional record key, each containing key, contactIdentifier, and json. Required: selector, collection_name.
• Delete Dotdigital contact transactional datas bulk delete Delete all transactional data for a dotdigital contact in a specific collection, identified by email or contact ID. Returns an empty 204 response on success. Required: selector, collection_name.
• List List all Dotdigital transactional datas List dotdigital transactional/insight data records from a named collection at account level. Returns: key, contactIdentifier, json. Required: collection_name. Max 100 records per page.
• List List all Dotdigital contacts transactional data collections List transactional/insight data collections at account and contact level in dotdigital. Returns: Id, Name. Up to 1000 records per page.
• Update Dotdigital transactional data empties bulk update Empty a dotdigital transactional data collection by removing all records from the specified collection. Returns an empty 204 response on success. Required: collection_name.
• List List all Dotdigital address book campaigns List campaigns sent to a dotdigital address book or segment. Returns: id, name, subject, fromName, fromAddress, htmlContent, plainTextContent, replyAction, replyToAddress, isSplitTest, status. Required: address_book_id.
• List List all Dotdigital address books List all address books in dotdigital. Returns: id, name, visibility, contacts.
• Create Create a Dotdigital address book Create a new address book in dotdigital. Returns: id, name, visibility, contacts. Required: name.
• Get Get single Dotdigital address book by ID Get a single dotdigital address book by id. Returns: id, name, visibility, contacts. Required: id.
• Update Update a Dotdigital address book by ID Update a dotdigital address book by id. Returns: id, name, visibility, contacts. Required: id, name.
• Delete Delete a Dotdigital address book by ID Delete a dotdigital address book by id. Returns an empty 204 response on success. Required: id.
• List List all Dotdigital address books privates List all private address books (private lists) in dotdigital. Returns each address book's id, name, visibility, and contact count.
• List List all Dotdigital address books publics List all public address books in dotdigital. Returns: id, name, visibility, contacts.
• List List all Dotdigital contacts unsubscribed sinces List dotdigital contacts who have unsubscribed from a specific address book since a given date. Returns each record with suppressedContact (id, email, optInType, emailType, dataFields, status), dateRemoved, and reason. Required: id, date.
• Create Create a Dotdigital contacts unsubscribe Unsubscribe a contact from the dotdigital account. Returns the suppressed contact object including id, email, optInType, emailType, dataFields, and status, plus dateRemoved and reason. Required: email.
• Create Create a Dotdigital contacts resubscribe Resubscribe a previously unsubscribed contact. Returns the contact and a resubscribe status of ContactAdded, ContactChallenged, ContactCannotBeUnsuppressed or NotAvailableInThisVersion. A status of ContactChallenged means an automated confirmation email was sent. Contact data fields can be updated as part of the resubscribe. Required in body: unsubscribedContact.
• Create Create a Dotdigital contacts resubscribe with no challenge Resubscribe a previously unsubscribed contact to a dotdigital address book without sending a challenge email. Returns a contact object (id, email, optInType, emailType, dataFields, status) and a result status. Required: id (address book ID) and unsubscribedContact containing email.
• Delete Delete a Dotdigital address book contact by ID Delete a contact from a dotdigital address book by id. Returns an empty 204 response on success. Required: address_book_id, id.
• List List all Dotdigital address book contacts List contacts in a dotdigital address book or segment. Returns: id, email, optInType, emailType, dataFields, status. Required: address_book_id.
• Create Create a Dotdigital address book contact Add a contact to a dotdigital address book. Returns the created contact object including id, email, optInType, emailType, dataFields, and status. Required: address_book_id, email.
• Delete Delete a Dotdigital contacts delete by ID Delete multiple contacts in dotdigital asynchronously using whichever identifier you wish. Returns: id, status. Required: body (array of 1 to 5000 contact identifiers). Max 5000 items per request.
• Get Get single Dotdigital contacts delete by ID Get the status of a dotdigital delete contacts job and its results if complete. Returns: id. Required: id.
• Delete Delete a Dotdigital contacts delete all by ID Delete all contacts from a dotdigital address book or list. Returns: id, status. Required: address_book_id. The operation is asynchronous and returns a 202 Accepted response with a job id for tracking.
• List List all Dotdigital contacts with preferences List dotdigital contacts who are opted into a given preference and belong to a given address book. Returns: id. Required: address_book_id, preference_id.
• Get Get single Dotdigital contacts with preference by ID Get dotdigital contacts who are opted into a given preference by preference id. Returns: id, email. Required: id.
• List List all Dotdigital with preference opt ins sinces List up to 1000 dotdigital contacts with a specific preference opt-in modified since a given date. Returns: contact, marketingPreferenceOptIns. Required: preference_id, date, addressBookId. Limited to top 1000 results.
• Create Create a Dotdigital import with merge option Bulk import contacts into a dotdigital address book with a specified merge option by uploading a base64-encoded file. Returns: id, status. Required: address_book_id, merge_option, filename, data. The merge_option accepts 0 (overwrite all data fields), 1 (skip blank values), or 2 (skip populated fields). Processing is asynchronous — the response returns a job id with status NotFinished.
• List List all Dotdigital surveys List all dotdigital survey forms in the account. Returns: id, url. Optional filter: assignedToAddressBookOnly. Max 500 results per request.
• Get Get single Dotdigital survey by ID Get a single dotdigital survey form by its integer id. Returns: id, url, example. Required: id.
• List List all Dotdigital surveys with activity sinces List dotdigital surveys that have had activity since the specified date. Returns each survey with its id, name, url, state, response totals, completion time statistics, and traffic source breakdowns. Required: date.
• List List all Dotdigital survey fields List the pages and fields of a dotdigital survey form. Each page has an id, name, and a fields array containing field definitions with type, text, isRequired, choices, and contact data field mapping. Required: survey_id.
• List List all Dotdigital survey responses List all responses submitted for a specific dotdigital survey form. Returns: id, email, started, dateStarted, complete, dateCompleted, givenAnswers. Required: survey_id.
• List List all Dotdigital responses with activity sinces List dotdigital survey responses that have changed since a specified date. Returns: id, email, started, dateStarted, complete, dateCompleted, givenAnswers. Required: survey_id, date. The date must be in ISO 8601 format.
• Update Dotdigital contacts suppress contacts bulk update Suppress a batch of contacts from a dotdigital account, identifying each by id or email address. Returns: suppressed, notFound.
• List List all Dotdigital contacts suppressed sinces List suppressed dotdigital contacts since a given date, along with the reason for each suppression. Returns: suppressedContact (with id, email, optInType, emailType, status), dateRemoved, and reason. Required: date (ISO 8601 date format).
• List List all Dotdigital preferences List all dotdigital preferences and preference categories. Returns: id, publicName, privateName, isPreference, order, isPublic, categoryId, preferenceCount, created, lastModified, preferences.
• Create Create a Dotdigital preference Create a new preference or preference category in dotdigital. Returns: id, publicName, privateName, isPreference, order, isPublic, categoryId, preferenceCount, created, lastModified. Required: publicName, privateName.
• Update Update a Dotdigital preference by ID Update a dotdigital preference or preference category by id. Returns: id, publicName, privateName, isPreference, order, isPublic, categoryId, lastModified. Required: id, publicName, privateName.
• Delete Delete a Dotdigital preference by ID Delete a dotdigital preference or preference category by id. Returns a plain text confirmation message. Required: id.
• List List all Dotdigital preferences modified sinces List dotdigital preferences and preference categories that have been modified since a given date. Returns each item with id, publicName, privateName, isPreference2, isPublic, categoryId, preferenceCount, created, lastModified, and a nested preferences array. Required: date.
• List List all Dotdigital contact preferences List all dotdigital preference categories for a contact and indicate which individual preferences the contact is opted into. Returns: id, example. Required: contact_identifier.
• Update Dotdigital contact preferences bulk update Update a dotdigital contact's preference opt-ins by sending an array of preference and preference category objects. Returns: value. Required: contact_identifier.
• List List all Dotdigital whatsapp clouds List all Cloud WhatsApp Channel configurations for a dotdigital API Space. Returns WhatsApp Cloud channel configuration objects with fields defined by the upstream schema. Filter by configurationStatus, wabaIds, phoneNumbers, or include deleted channels.
• Create Create a Dotdigital whatsapp cloud Create a new Cloud WhatsApp Channel configuration in dotdigital. Returns an empty 202 Accepted response on success.
• Get Get single Dotdigital whatsapp cloud by ID Get a WhatsApp Cloud Channel configuration by id from dotdigital. Returns: phoneNumber, wabaId, configurationStatus. Required: id.
• Delete Dotdigital whatsapp clouds bulk delete Delete a WhatsApp Cloud Channel number configuration in dotdigital permanently. Returns an empty 204 response on success. Required: phone_number. This action cannot be undone.
• Create Create a Dotdigital cloud register Register a WhatsApp Cloud configuration for a phone number in dotdigital. Returns a registration result object indicating the outcome of the cloud registration attempt. Required: phone_number. The phone number must be in E164 format and associated with a WhatsApp Business Messaging account.
• List List all Dotdigital businessaccount templates List WhatsApp templates for a specific WhatsApp Business Account (WABA) in dotdigital. Returns the collection of WhatsApp templates associated with the account. Required: waba_id.
• Get Get single Dotdigital businessaccount template by ID Get a WhatsApp template for a specific WABA in dotdigital by template id. Returns the WhatsApp template object including id and template-specific attributes defined in the upstream whatsAppTemplate schema. Required: waba_id, id.
• List List all Dotdigital analytics conversationmessages List dotdigital conversation message analytics aggregated by time period. Returns the count of sent, delivered, and read messages for each period bucket. Required: from, to.
• List List all Dotdigital analytics chats List dotdigital chat analytics for a specific time period, optionally filtered by team or agent and aggregated by time-based or team/agent dimensions. Returns an array of chat analytics records with aggregation-dependent attributes whose fields vary based on the `by` criteria. Required: from, to.
• List List all Dotdigital chats lives List live chat analytics from dotdigital, optionally filtered by a specific team and aggregated by team or agent. Returns an array of live chat analytics records, each containing attributes with the aggregated metrics. The exact field set is defined by the upstream liveChatAnalytics OpenAPI schema, which is not fully resolved in the discovered source.
• List List all Dotdigital analytics messages List dotdigital message analytics aggregated over a date range. Returns: counts of sent, delivered, read, inbound, and failed messages plus segments used. Required: from, to.
• List List all Dotdigital messages metrics List dotdigital message metrics for a specific time period, optionally aggregated by hour, day, month, year, alltime, system, or recipient country code. Returns an array of message metric objects per the ApiProfilingAnalytics schema with schema-specific fields. Required: from, to.
• List List all Dotdigital analytics sessions List session analytics from dotdigital CPaaS for a given time range, optionally aggregated by hour, day, month, or year. Returns, for each aggregation period, the count of started sessions and the count of explicitly ended sessions. Required: from, to.
• List List all Dotdigital sms trackings List SMS URL tracking analytics from dotdigital, aggregated by time period. Returns: period, sentUrls, clicks. Required: from, to.
• List List all Dotdigital sms verifies List SMS verify analytics from dotdigital, aggregated over a time range. Returns an array of analytics records with counts of notVerified, verified, expired, and locked verify calls. Required: from, to.
• List List all Dotdigital sms inbounds List inbound SMS analytics from dotdigital aggregated over a UTC date range. Returns: datetime, received. Required: from, to.
• List List all Dotdigital sms outbounds Retrieve outbound SMS analytics from dotdigital, aggregated by time period. Returns an array of analytics records each containing period, submitted, delivered, filtered, and undeliverable message counts. Required: from, to.
• List List all Dotdigital whatsapp conversations List WhatsApp conversation analytics in dotdigital, aggregated by time period with optional breakdowns by category, direction, type, country, and phone number. Returns: period, conversation, conversation_category, conversation_direction, conversation_type, country, phone. Required: from, to.
• List List all Dotdigital whatsapp dailymessagingusages List WhatsApp business-initiated conversation analytics for the last 24 hours in dotdigital. Returns an array of daily messaging usage objects containing the counts of marketing, utility, and authentication conversations. Optional: wabaIds.
• Get Get single Dotdigital cpaas chat by ID Get a specific dotdigital CPaaS chat by id. Returns the full Chat object including its id. Required: id. Optionally set includeDeleted to true to retrieve soft-deleted chats.
• Update Update a Dotdigital cpaas chat by ID Update a dotdigital CPaaS chat by id. Returns: id. Required: id. An optional if-match ETag header supports optimistic concurrency control.
• Delete Delete a Dotdigital cpaas chat by ID Delete a dotdigital chat by id. Returns an empty 204 response on success. Required: id.
• List List all Dotdigital cpaas chats List dotdigital chats with optional filtering by profile, scope, and inclusion of closed or deleted chats. Returns: id.
• Create Create a Dotdigital cpaas chat Create a new chat in dotdigital CPaaS. Returns the created chat object including id, created_at, and updated_at. A JSON request body with chat details is required. Returns 409 if the chat already exists.
• Update Dotdigital cpaas chats bulk update Assign a dotdigital chat to an agent by providing assignment details in the request body. Returns the updated chat object including its id. Required: chat_id.
• Update Dotdigital chat closes bulk update Close a dotdigital CPaaS chat by chat_id. Returns the updated chat object including its id. Required: chat_id.
• Update Dotdigital chat channels bulk update Change the channel for an existing dotdigital chat. Returns the updated chat object including its id. Required: chat_id. An optional if-match ETag header can be supplied for optimistic concurrency control.
• Create Create a Dotdigital chat form Send a form to a dotdigital chat by chat id. The request body contains options relating to sending a form to a chat. Returns an empty 200 response on success. Required: chat_id.
• Create Create a Dotdigital chat typing Send a typing indicator for a dotdigital chat, signalling that the caller is currently typing in that chat. Returns an empty 204 response on success. Required: chat_id.
• Delete Dotdigital chat typings bulk delete Stop the typing indicator for a dotdigital chat, signalling that the caller has stopped typing in that chat. Returns an empty 204 response on success. Required: chat_id.
• List List all Dotdigital chat participants List participants of a specific dotdigital chat. Returns each participant's id and attributes. Required: chat_id.
• List List all Dotdigital chat configs Retrieve the chat configuration for a dotdigital apiSpace. Returns: attributes. No caller-supplied parameters required; the apiSpace is determined by authentication context.
• Get Get single Dotdigital config team by ID Get the members of a dotdigital chat team by id. Returns the team member details object including id and attributes, where attributes contains the member fields defined by the dotdigital teamMembers schema. Required: id.
• Delete Delete a Dotdigital config team by ID Delete the configuration for a dotdigital chat team by id. Returns an empty 200 response on success. Required: id.
• Update Dotdigital team app messagings bulk update Update the App Messaging configuration for a team in dotdigital. Returns the updated appMessagingConfig object. Required: team_id.
• Delete Dotdigital team app messagings bulk delete Delete the App Messaging configuration for a team in dotdigital. Returns an empty 204 response on success. Required: team_id.
• Update Dotdigital team settings bulk update Update general settings for a dotdigital chat team. Returns the full updated team settings object as defined in the upstream settings schema. Required: team_id.
• Delete Dotdigital team settings bulk delete Remove the general settings for a dotdigital chat team. Returns an empty 200 response on success. Required: team_id.
• Create Create a Dotdigital messages statusupdate Post message status updates back to a dotdigital conversation. Accepts a JSON array of MessageStatusUpdate objects describing the per-message status changes. Required: conversation_id. Returns a 200 success acknowledgment confirming the status updates were received, with no response body.
• List List all Dotdigital cpaas presences Retrieve presence settings for agent profiles in dotdigital CPaaS by profile id, optionally filtering by current status. Returns: id. Required: id.
• List List all Dotdigital presence appmessagings List App Messaging presence settings for user profiles in dotdigital by profile id. Returns the presence information for each requested profile. Required: id.
• Create Create a Dotdigital cpaas content Upload a file to dotdigital CPaaS content storage. Returns the uploaded file object including its id, created_at, and updated_at. Required: a request body with the file details and data.
• Get Get single Dotdigital cpaas content by ID Retrieve a file from dotdigital CPaaS content storage by id. Returns the file object including its id, created_at, and updated_at. Required: id.
• Delete Delete a Dotdigital cpaas content by ID Delete a file from dotdigital CPaaS content storage by id. Returns an empty 204 response on success. Required: id.
• Get Get single Dotdigital cpaas conversation by ID Get a dotdigital CPaaS conversation by id. Returns the conversation object including its id. Required: id.
• Update Update a Dotdigital cpaas conversation by ID Update a dotdigital CPaaS conversation by id. Returns the updated conversation object including its id. Required: id.
• Delete Delete a Dotdigital cpaas conversation by ID Delete a dotdigital CPaaS conversation by id. Returns an empty 204 response on success. Required: id.
• List List all Dotdigital cpaas conversations List dotdigital CPaaS conversations, optionally filtered by scope, profile participation, or deleted status. Returns: id.
• Create Create a Dotdigital cpaas conversation Create a new dotdigital CPaaS conversation. Returns the created conversation object including its id.
• Create Create a Dotdigital conversation typing Indicate that the caller is typing in a dotdigital conversation. Returns an empty 204 response on success. Required: conversation_id.
• Delete Dotdigital conversation typings bulk delete Indicate that the caller has stopped typing in a dotdigital conversation. Returns an empty 204 response on success. Required: conversation_id.
• List List all Dotdigital conversation participants List all participants in a dotdigital conversation. Returns: id. Required: conversation_id.
• Create Create a Dotdigital conversation participant Add a list of participants to a dotdigital conversation by sending an array of participant objects. Returns an empty 201 response on success. Required: conversation_id.
• Delete Dotdigital conversation participants bulk delete Remove a list of participants from a dotdigital conversation by their profile ids. Returns an empty 204 response on success. Required: conversation_id, id.
• List List all Dotdigital sms dedicated numbers List SMS dedicated phone numbers allocated to your dotdigital account. Returns: number, countryIsoCode.
• List List all Dotdigital sms shortcodes List SMS shortcodes in dotdigital. Returns: number, keyword, countryIsoCode.
• List List all Dotdigital sms keywords List SMS keywords in dotdigital. Returns: number, keyword, countryIsoCode.
• Create Create a Dotdigital facebook state Generate Facebook metadata to help attach a Facebook Messenger ID to a dotdigital CPaaS profile. Returns an encoded string token used for the association. Required: apiSpaceId, profileId.
• Get Get single Dotdigital data firehose configuration by ID Get a dotdigital Data Firehose configuration by id. Returns: id. Required: id.
• Update Update a Dotdigital data firehose configuration by ID Update a dotdigital Data Firehose configuration with new details. Returns: id. Required: id.
• Delete Delete a Dotdigital data firehose configuration by ID Delete a dotdigital Data Firehose configuration by id. Returns an empty 204 response on success. Cannot be deleted while a data sync is in progress (returns 409). Required: id.
• Create Create a Dotdigital data firehose configuration Create a new dotdigital Data Firehose configuration. Returns: id.
• Update Dotdigital configuration status bulk update Update the status of a dotdigital Data Firehose configuration by setting it to enabled or disabled. Required: id, new_status. Returns an empty 204 response on success.
• List List all Dotdigital configuration custom identifiers List all custom identifiers defined for the dotdigital account. Returns: name.
• Create Create a Dotdigital configuration custom identifier Create a new custom identifier in dotdigital that will be available to identify contacts. Returns: name. Required: name. The name must be less than 50 characters and must not already exist.
• Delete Dotdigital configuration custom identifiers bulk delete Delete a custom identifier by name in dotdigital if it exists. Returns an empty 204 response on success. Required: name.
• Get Get single Dotdigital insight data import by ID Get the status and results of a dotdigital Insight data import by id. Returns: importId, status, collectionName, summary, failures. Required: id.
• Update Dotdigital insight data imports bulk update Bulk import Insight data records into a dotdigital collection, upserting existing or creating new records asynchronously. Returns: importId, status. Required: collectionName, collectionScope, collectionType, records. If targeting a contact-scoped collection, each record must include a contactIdentity. Check import completion by polling the get import status endpoint with the returned importId.
• Get Get single Dotdigital insight data async by ID Get the status of an asynchronous Insight data job in dotdigital by id, including any results if available. Returns: jobId, status. Required: id. Use this endpoint to poll the progress of async operations such as emptying or deleting collections.
• List List all Dotdigital insight data collections List all Insight data collections in dotdigital at both account and contact level. Returns: type.
• Create Create a Dotdigital insight data collection Create an empty Insight data collection in dotdigital. If the collection already exists, a successful result is returned. Returns an empty response on success (201 when created, 200 if already exists). Maximum of 1000 Insight data collections per account. Required: collection_name, collectionScope, collectionType.
• Delete Dotdigital insight data collections bulk delete Delete an Insight data collection and all its records in dotdigital. The deletion is asynchronous and progress can be monitored via getAsyncStatus. Deleting a contact-scoped collection deletes it for all contacts. Returns: jobId. Required: collection_name.
• Delete Dotdigital account delete records bulk delete Delete 1 to 5000 records from a dotdigital account scoped Insight Data collection by specifying record keys in the request body. Returns the delete confirmation response with operation attributes. Required: collection_name.
• Delete Dotdigital collection empties bulk delete Empty all records from a dotdigital Insight data collection without deleting the collection itself, preserving dependencies on product recommendations, campaigns, and segments. Returns: jobId. Required: collection_name. The deletion is asynchronous and progress can be monitored via the async status endpoint.
• List List all Dotdigital collection schemas Get the JSON schema for a dotdigital Insight data collection by collection name. Returns the collection's schema definition (attributes) that all records added to the collection must adhere to, though records are allowed to extend it. Required: collection_name.
• List List all Dotdigital insight data accounts List all Insight data collections for a dotdigital account. Returns: _links, _items. Results are paginated.
• Update Update a Dotdigital insight data account by ID Upsert a record into an account Insight data collection in dotdigital, creating it if it does not exist or replacing it if it does. Returns an empty 201 response on creation or 204 on replacement. Required: collection_name, id.
• Delete Delete a Dotdigital insight data account by ID Delete a single record from an account Insight data collection in dotdigital. Returns an empty 204 response on success. Required: collection_name, id.
• Get Get single Dotdigital insight data account by ID Get a single record from an account Insight data collection in dotdigital. Returns: _links, _items. Required: collection_name, id.
• List List all Dotdigital insight data contacts List Insight data records from a contact-scoped collection in dotdigital. Records are returned in ascending order. Returns: id, name, created, updated, marketSector, users. Required: collection_name. Max 5000 records per page.
• Update Update a Dotdigital insight data contact by ID Upsert (create or replace) an Insight data record in a contact-scoped Insight data collection for a specific dotdigital contact. The request body is a free-form JSON object whose fields depend on the collection schema. Returns an empty 204 response on success (or 201 when a new record is created). Required: identifier, value, collection_name, id.
• Delete Delete a Dotdigital insight data contact by ID Delete a single Insight data record from a contact's collection in dotdigital. Returns an empty 204 response on success. Required: identifier, value, collection_name, id.
• Get Get single Dotdigital insight data contact by ID Retrieve a single Insight data record from a contact's collection in dotdigital. Returns: id, name, created, updated, marketSector, users, _links, _items. Required: identifier, value, collection_name, id.
• Delete Dotdigital delete records bulk delete Delete 1 to 5000 records from a contact-scoped Insight Data collection in dotdigital in a single call. Returns a confirmation of the bulk delete operation. Required: identifier, value, collection_name, keys.
• Delete Dotdigital empties bulk delete Empty all records from a specified Insight data collection for a single contact in dotdigital. The collection itself is not deleted, so new data can be added without affecting data dependencies. The deletion is asynchronous and can be monitored via getAsyncStatus. Returns: jobId. Required: identifier, value, collection_name.
• Create Create a Dotdigital events import Import a batch of events associated to contacts in dotdigital. The request body is a JSON array of 1–5000 event objects processed asynchronously. Returns a 202 Accepted response with no body, indicating the import is being processed. Required: body.
• Get Get single Dotdigital events export by ID Retrieve a set of queued events from a dotdigital events subscription by id. Returns: checkPoint, events. Omit checkPoint on the first call to get the earliest queued events; pass the returned checkPoint on subsequent calls to page through newer events. Required: id. Maximum call duration is 30 seconds; subscriptions not polled within 30 days are automatically set to inactive.
• List List all Dotdigital export subscriptions List all dotdigital events subscriptions and their details. Returns: id, name, status, subscribedEventTypes, alertsConfiguration, created, updated.
• Create Create a Dotdigital export subscription Create a dotdigital events subscription. The name must be unique within the account's subscriptions; all filters on an event type must match (logical AND). Returns: id, status, subscribedEventTypes, alertsConfiguration, created, updated, name. Required: name, status, subscribedEventTypes, alertsConfiguration.
• Get Get single Dotdigital export subscription by ID Get a single dotdigital events subscription by id. Returns: id, name, status, subscribedEventTypes, alertsConfiguration, created, updated. Required: id.
• Update Update a Dotdigital export subscription by ID Update a dotdigital events subscription by id with new details. All filters on an event type must match (logical AND). Returns: id, name. Required: id, name, status, subscribedEventTypes, alertsConfiguration.
• Delete Delete a Dotdigital export subscription by ID Delete a dotdigital events subscription by id. Once deleted it cannot be restored — this is a destructive call. Returns an empty 204 response on success. Required: id.
• Get Get single Dotdigital events lob by ID Get a large object (LOB) from dotdigital events by id. Returns the binary large object data; the content-type header indicates the data type. Required: id.
• Create Create a Dotdigital marketing email send Send a marketing email in dotdigital via raw HTML or a triggered campaign template. Returns a 201 response with no body on success. Required: to, from, content. Marketing emails must include the '$UNSUB$' unsubscribe token; email marketing status is checked for known addresses and contacts are created for unknown ones.
• Create Create a Dotdigital marketing email batch Send a batch of marketing emails in dotdigital. Unsubscribed or suppressed contacts are skipped; unknown addresses are created as contacts. Returns a 201 response confirming the email batch was accepted. Required: body (array of email request objects, minimum 1 item, each with to, from, and content). HTML content must include an unsubscribe link ($UNSUB$ token).
• List List all Dotdigital cpaas profiles List dotdigital CPaaS profiles matching the search criteria. Returns: id. The query uses mongo-querystring syntax; numeric strings can be wrapped in single quotes to prevent interpretation as numbers.
• Update Dotdigital cpaas profiles bulk update Create or update multiple dotdigital CPaaS profiles in a single request. Returns an empty 200 response on success.
• Delete Dotdigital cpaas profiles bulk delete Delete multiple dotdigital CPaaS profiles by id. Returns an empty 200 response on success. Required: id.
• Get Get single Dotdigital cpaas profile by ID Get a single dotdigital CPaaS profile by id. Returns: id. Required: id.
• Update Update a Dotdigital cpaas profile by ID Update or undelete a dotdigital CPaaS profile by id. Returns: id. Underscore (_) characters are not allowed in profile field names. Required: id.
• Delete Delete a Dotdigital cpaas profile by ID Delete a dotdigital CPaaS profile by id. Returns an empty 204 response on success. Required: id.
• Create Create a Dotdigital cpaas profile Create a new dotdigital CPaaS profile with custom fields. Returns the created profile including its id and all custom profile fields. Underscore (_) characters are not allowed in profile field names.
• Update Dotdigital cpaas profiles partial update Partially update a dotdigital CPaaS profile by id, changing only the supplied properties while leaving others intact. Returns the updated profile including its id and all custom profile fields. Required: id and a profile body. Underscore (_) characters are not allowed in profile field names.
• List List all Dotdigital automation inboundrules List dotdigital inbound rule configurations. Returns the configuration objects with schema-defined fields.
• Create Create a Dotdigital automation inboundrule Create a dotdigital inbound rule configuration. Returns the created configuration object with schema-defined fields.
• Get Get single Dotdigital automation inboundrule by ID Get a single dotdigital inbound rule configuration by id. Returns the configuration object with schema-defined fields. Required: id.
• Update Update a Dotdigital automation inboundrule by ID Update a dotdigital inbound rule configuration by id. Returns the updated configuration object with schema-defined fields. Required: id.
• Delete Delete a Dotdigital automation inboundrule by ID Delete a dotdigital inbound rule configuration by id. Returns an empty 204 response on success. Required: id.
• Create Create a Dotdigital message status Post a status for a dotdigital message. Returns the created message status object confirming the status was received. Required: message_id, status. Valid status values: failed, delivered, read, expired, sent, filtered.
• Get Get single Dotdigital cpaas message by ID Get a specific CPaaS message in dotdigital by id. Returns the message details including its id. Required: id.
• Update Update a Dotdigital cpaas message by ID Patch a CPaaS message in dotdigital by id. Returns an empty 202 response on success. Required: id, a request body with patch options.
• Delete Delete a Dotdigital cpaas message by ID Delete a CPaaS message in dotdigital by id. Returns an empty 204 response on success. Required: id.
• Create Create a Dotdigital cpaas message Send a new CPaaS message in dotdigital. Returns the created message object including its id. Required: a request body with message details and options.
• Create Create a Dotdigital messages batch Send a batch of outbound omnichannel messages in one call. The request body is an ARRAY of message objects. Returns an array of {index, messageId} pairs, where index is the 0-based position in the submitted batch. Required per message: to, rules. Max 5000 messages or 50MB per call.
• Create Create a Dotdigital messages inbound Post an inbound message to dotdigital CPaaS. Returns the accepted inbound message object including its id and message attributes. The request body (InboundMessage schema) is required.
• Create Create a Dotdigital inbound status Post a delivery or read status for an inbound message in dotdigital. Returns the inbound message object including its id. Required: inbound_message_id, status. Valid status values: delivered, read.
• List List all Dotdigital phonevalidation singles Validate a single phone number in dotdigital. Returns a validation result object with details about the submitted number. Required: phoneNumber. Provide countryCode when the number is in local format.
• List Dotdigital cpaas phonevalidations bulk list List bulk phone number validation jobs in dotdigital. Returns an array of JobDetails objects, each containing the job's jobId and status. No required parameters.
• Create Dotdigital cpaas phonevalidations bulk create Queue a bulk phone number validation job in dotdigital by uploading a CSV file of phone numbers to validate. Returns the unique job identifier as an integer for tracking the asynchronous validation job. Required: file. Only one file per call is allowed; the job runs asynchronously.
• Get Get single Dotdigital phonevalidation bulk by ID Get the details and current status of a dotdigital bulk phone number validation job by its job id. Returns: id. Required: id.
• List List all Dotdigital results Get the results CSV file of a successful bulk phone number validation job in dotdigital. Returns a CSV file with columns including Phone Number, Status, MCCMNC, Network Name, Is Ported, and Roaming details. Required: job_id. Failed or incomplete jobs return no data.
• Create Create a Dotdigital profiles export Export dotdigital profile query results as a formatted file for download. Returns the exported data in the requested format. For CSV exports, only primitive types are included; nested fields must be referenced explicitly (e.g., address.line1). No required parameters.
• Update Dotdigital profile optins bulk update Set opt-in preferences for specified channels on a dotdigital CPaaS profile. Returns the full profile with updated opt-in settings. Required: id.
• Delete Dotdigital profile optins bulk delete Opt out a dotdigital profile from specified channels by removing its opt-in settings. Returns the full profile object with updated opt-in settings. Required: id.
• Update Update a Dotdigital rels primary by ID Create a primary profile relationship in dotdigital where the linked profile is the primary and this profile is a child. Returns the updated profile object including its id and profile-specific attributes. Required: id, linked_id.
• Delete Delete a Dotdigital rels primary by ID Delete a dotdigital profile's relationship to its primary profile. Returns the updated profile object including its id and profile-specific attributes. Required: id, linked_id.
• Update Update a Dotdigital rels link by ID Create a relationship link in dotdigital where the primary profile is the parent and the linked profile becomes a child. Returns: id. Required: id, linked_id.
• Delete Delete a Dotdigital rels link by ID Delete a profile relationship link in dotdigital, removing the primary profile's parent relationship to the linked child profile. Returns: id. Required: id, linked_id.
• Delete Delete a Dotdigital profile device by ID Remove a device from a dotdigital profile and close related open sessions. Returns an empty 204 response on success. Required: api_space_id, id, device_id.
• Create Create a Dotdigital push validation Validate push notification capabilities for dotdigital profiles by submitting a list of profile IDs to query. Returns the push capabilities summary object. Required: api_space_id.
• List List all Dotdigital profiles optins Get the default profile opt-in/out options for each channel in the dotdigital CPaaS channel service. Returns a map of channel names to boolean opt-in values where true means default opt in and false means default opt out.
• Update Dotdigital profiles optins bulk update Set the default profile opt-in/out options for each channel in the dotdigital CPaaS channel service. Returns the updated map of channel names to boolean opt-in values where true means default opt in and false means default opt out.
• List List all Dotdigital tokens anons Get an anonymous session token in dotdigital that can be used to start an anonymous session. Returns: token. Required: id, nonce.
• Get Get single Dotdigital cpaas session by ID Get details about a specific dotdigital CPaaS session by id. Returns: id. Required: id.
• Delete Delete a Dotdigital cpaas session by ID Delete a dotdigital CPaaS session by id, ending the session and revoking access to services. Returns an empty 204 response on success. Required: id.
• List List all Dotdigital cpaas templates List all available dotdigital CPaaS templates. Returns each template with id and attributes containing the full template fields as defined in the dotdigital OpenAPI templateFull schema.
• Create Create a Dotdigital cpaas template Create a new dotdigital CPaaS template by supplying template details in the request body. Returns the created template with id and attributes containing the full template fields as defined in the dotdigital OpenAPI templateFull schema.
• Get Get single Dotdigital cpaas template by ID Get a single dotdigital CPaaS template by id. Returns the template with id and attributes containing the full template fields as defined in the dotdigital OpenAPI templateFull schema. Required: id.
• Update Update a Dotdigital cpaas template by ID Update a dotdigital CPaaS template by id, supplying updated template details in the request body. Returns the updated template with id and attributes containing the full template fields as defined in the dotdigital OpenAPI templateFull schema. Required: id.
• Delete Delete a Dotdigital cpaas template by ID Delete a dotdigital CPaaS template by id. Returns an empty 204 response on success. Required: id.
• List List all Dotdigital cpaas webhooks List dotdigital webhook configurations for the account. Returns each configuration's id, macBatchSize, and batchTimeout. Set includeDeleted to true to also return deleted webhook configurations.
• Create Create a Dotdigital cpaas webhook Create a new dotdigital webhook configuration and start streaming events. Batching is encouraged — a batch is sent when the number of events reaches macBatchSize or after batchTimeout seconds, whichever occurs first. Returns: id, url, secret, subscriptions, batch, name. Required: name, url.
• Get Get single Dotdigital cpaas webhook by ID Get a single dotdigital webhook configuration by id. Returns: id, name, url, secret, subscriptions, batch. Set includeDeleted to true to also retrieve deleted webhook configurations. Required: id.
• Update Update a Dotdigital cpaas webhook by ID Update an individual dotdigital webhook configuration by id. Returns: id, name, url, secret, subscriptions, batch. Required: id, name, url.
• Delete Delete a Dotdigital cpaas webhook by ID Delete a dotdigital webhook by id. Returns an empty 204 response on success. Required: id.
• List List all Dotdigital webhooks availableevents List available dotdigital webhook events you can subscribe to, along with optional filters for refining event selection. Returns the available events and their optional filters; set includeSchemas to true to also receive schema information for each event.
• List List all Dotdigital webhooks availabletemplates List available webhook event templates in dotdigital that can be used when creating a webhook. Event templates are pre-defined groups of events covering common use-cases. Returns: name, description, events.
• List List all Dotdigital chat messages List dotdigital chat messages for a specific chat, retrieving messages from a point in time and working backwards through chat events. Returns: id. Required: chat_id.
• Create Create a Dotdigital chat message Send a message to a dotdigital chat. The request body contains the message details to send, and the response confirms the message was successfully sent. Required: chat_id.
• List List all Dotdigital chat events List events for a dotdigital chat, reading forward from a given event id. Returns an array of MessageEvent objects including id and event-specific attributes. Required: chat_id.
• List List all Dotdigital conversation messages List dotdigital conversation messages, working backwards from a given event in time. Returns partial and complete messages aggregated from the conversation events. Required: conversation_id. Max 100 messages per page.
• Create Create a Dotdigital conversation message Send a message into an existing dotdigital conversation. Returns the created message id and the event id it occupies in the conversation stream. Required: conversation_id. Required in body: parts.
• List List all Dotdigital conversation events List conversation events for a dotdigital conversation by reading forward from a specified event id. Returns: id. Required: conversation_id.
• List List all Dotdigital address book contact scores List contact scoring for contacts within a specific dotdigital address book or segment. Returns: contactId, email, dateModified, scoreLabel, score, engagement, suitability. Required: address_book_id. Max 1000 records per page.
• List List all Dotdigital insight data accounts by collection List all records from a dotdigital Insight data account-level collection. Returns: id, name, created, updated, marketSector, users. Required: collection_name. All data is returned in ascending order.
• List List all Dotdigital insight data contacts by identifier Get a dotdigital contact's details by a specific identifier (contactId, email, mobileNumber, or a custom identifier). Returns the contact object including contactId, identifiers, dataFields, and status. Required: identifier, value. The value must match the type of the identifier.
• List List all Dotdigital insight data contacts by collection List insight data records for a specific dotdigital contact within a named collection. Returns: id, name, created, updated, marketSector, users. Required: identifier, value, collection_name.

No tools match your search.