How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dotdigital API Contact API

The ApiContact API from Dotdigital — 43 operation(s) for apicontact.

Dotdigital API Contact API is one of 63 APIs that Dotdigital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ApiContact. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 54 operations across 43 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, https://r1-api.dotdigital.com.

54 operations 43 paths 29 schemas 6 DELETE28 GET15 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://r1-api.dotdigital.com/v2
Resource Areas
1

Paths & Operations 54

Across 43 paths, the API surfaces 54 operations — 6 DELETE, 28 GET, 15 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

ApiContact 54
GET
/v2/contacts/suppressed-since/{date}
Gets a list of suppressed contacts after a given date along with the reason for suppression.
ApiContact_GetSuppressedContacts 3 params → 200
GET
/v2/contacts/unsubscribed-since/{date}
Gets a list of unsubscribed contacts who unsubscribed after a given date.
ApiContact_GetUnsubscribedContacts 3 params → 200
GET
/v2/contacts/modified-since/{date}
Gets a list of modified contacts after a specified date.
ApiContact_GetModifiedContacts 4 params → 200
GET
/v2/contacts/created-since/{date}
Gets a list of created contacts after a specified date.
ApiContact_GetNewContacts 4 params → 200
GET
/v2/contacts
Gets a list of all contacts in the account.
ApiContact_GetContacts 3 params → 200
POST
/v2/contacts
Creates a contact.
ApiContact_CreateContact body → 201
GET
/v2/contacts/{id}
Gets a contact by ID. Unsubscribed or suppressed contacts will not be retrieved.
ApiContact_GetContactById 1 param → 200
PUT
/v2/contacts/{id}
Updates a contact.
ApiContact_UpdateContact 1 param body → 200
DELETE
/v2/contacts/{id}
Deletes a contact.
ApiContact_DeleteContact 1 param → 204
GET
/v2/contacts/{id}/with-consent
Gets a contact by ID with consent records.
ApiContact_GetContactByIdWithConsent 1 param → 200
PUT
/v2/contacts/{id}/with-consent
Updates a contact with consent records.
ApiContact_UpdateContact2 1 param body → 200
GET
/v2/contacts/{email}
Gets a contact by email address.
ApiContact_GetContactByEmail 1 param → 200
GET
/v2/contacts/{email}/with-consent
Gets a contact by email address with consent records.
ApiContact_GetContactByEmailWithConsent 1 param → 200
POST
/v2/contacts/with-consent
Creates a contact with consent records.
ApiContact_CreateContactWithConsent body → 201
POST
/v2/contacts/with-consent-and-preferences
Creates a contact with consent and preference records.
ApiContact_CreateContactWithConsentAndPreferences body → 201
PUT
/v2/contacts/{id}/with-consent-and-preferences
Updates a contact with consent and preference records.
ApiContact_UpdateContact3 1 param body → 200
DELETE
/v2/address-books/{addressBookId}/contacts/{contactId}
Deletes a contact from a given list.
ApiContact_DeleteContactFromAddressBook 2 params → 204
DELETE
/v2/address-books/{addressBookId}/contacts
Deletes all contacts from a given list.
ApiContact_DeleteAllContactsFromAddressBookWithoutProgress 1 param → 204
GET
/v2/address-books/{addressBookId}/contacts
Gets a list of contacts in a given list.
ApiContact_GetContactsInAddressBook 4 params → 200
POST
/v2/address-books/{addressBookId}/contacts
Adds a contact to a given list.
ApiContact_AddContactToAddressBook 1 param body → 200
POST
/v2/address-books/{addressBookId}/contacts/delete-all
Deletes all contacts from a given list.
ApiContact_DeleteAllContactsFromAddressBook 1 param → 202
POST
/v2/address-books/{addressBookId}/contacts/delete
Deletes multiple contacts from a list. This will run in the background, and for larger lists may take some minutes to fully delete.
ApiContact_DeleteContactsFromAddressBook 1 param body → 202
GET
/v2/contacts/deletion/{deletionRequestId}
Gets the status of a previously started request to delete contacts from a list.
ApiContact_GetBulkContactDeletionProgress 1 param → 200
GET
/v2/address-books/{addressBookId}/contacts/modified-since/{date}
Gets a list of contacts who were modified since a given date, in a given list.
ApiContact_GetModifiedContactsInAddressBook 5 params → 200
GET
/v2/address-books/{addressBookId}/contacts/unsubscribed-since/{date}
Gets a list of contacts who have unsubscribed from a given list.
ApiContact_GetUnsubscribedContactsInAddressBook 4 params → 200
POST
/v2/contacts/unsubscribe
Unsubscribes contact from account.
ApiContact_UnsubscribeContact body → 200
PUT
/v2/contacts/suppress-contacts
Suppresses a batch of contacts from account.
ApiContact_SuppressContacts body → 200
POST
/v2/address-books/{addressBookId}/contacts/unsubscribe
Unsubscribes contact from a given list.
ApiContact_UnsubscribeContactFromAddressBook 1 param body → 200
POST
/v2/contacts/resubscribe
Resubscribes a previously unsubscribed contact.
ApiContact_ResubscribeContact body → 200
POST
/v2/contacts/resubscribe-with-no-challenge
Resubscribes a previously unsubscribed contact with no challenge.
ApiContact_ResubscribeContactWithNoChallenge body → 200
POST
/v2/address-books/{addressBookId}/contacts/resubscribe
Resubscribes a previously unsubscribed contact to a given list.
ApiContact_ResubscribeContactToAddressBook 1 param body → 200
POST
/v2/address-books/{addressBookId}/contacts/resubscribe-with-no-challenge
Resubscribes a previously unsubscribed contact to a given list with no challenge.
ApiContact_ResubscribeContactToAddressBookWithNoChallenge 1 param body → 200
POST
/v2/contacts/transactional-data/{collectionName}
Adds a single piece of transactional data to a contact.
ApiContact_AddTransactionalData 1 param body → 201
GET
/v2/contacts/transactional-data/{collectionName}
ApiContact_GetTransactionalDataByCollectionFromId 3 params → 200
POST
/v2/contacts/transactional-data/import/{collectionName}
Adds multiple pieces of transactional data to contacts asynchronously, returning an identifier that can be used to check for import progress.
ApiContact_ImportTransactionalData 1 param body → 202
GET
/v2/contacts/transactional-data/import/{importId}
Gets the import status of a previously started transactional import.
ApiContact_GetTransactionalDataImportProgress 1 param → 200
GET
/v2/contacts/transactional-data/import/{importId}/report
Gets a report with statistics about what was successfully imported, and what was unable to be imported.
ApiContact_GetTransactionalDataImportReport 1 param → 200
POST
/v2/contacts/transactional-data/{collectionName}/{key}
Replaces a piece of transactional data by key (logicall equivalent to a delete and an insert).
ApiContact_ReplaceTransactionalDataByKey 2 params body → 200
DELETE
/v2/contacts/transactional-data/{collectionName}/{key}
Deletes a piece of transactional data by key.
ApiContact_DeleteTransactionalDataByKey 2 params → 204
GET
/v2/contacts/transactional-data/{collectionName}/{key}
Gets a piece of transactional data by key.
ApiContact_GetTransactionalDataByKey 2 params → 200
PUT
/v2/contacts/transactional-data/{collectionName}/empty
Removes all items from a transactional data collection.
ApiContact_EmptyTransactionalDataCollection 1 param → 204
DELETE
/v2/contacts/{id}/transactional-data/{collectionName}
Deletes all transactional data for a contact.
ApiContact_DeleteTransactionalDataByContactId 2 params → 204
GET
/v2/contacts/{id}/transactional-data/{collectionName}
Gets a list of all transactional data for a contact (100 most recent only).
ApiContact_GetTransactionalDataByContactId 2 params → 200
DELETE
/v2/contacts/{email}/transactional-data/{collectionName}
Deletes all transactional data for a contact.
ApiContact_DeleteTransactionalDataByContactEmail 2 params → 204
GET
/v2/contacts/{email}/transactional-data/{collectionName}
Gets a list of all transactional data for a contact (100 most recent only).
ApiContact_GetTransactionalDataByContactEmail 2 params → 200
GET
/v2/transactional-data/{collectionName}
Gets a list of account scoped transactional data for given collection
ApiContact_GetAccountScopedTransactionalData 3 params → 200
GET
/v2/contacts/transactional-data-collections
Gets a list of transactional data collections.
ApiContact_GetTransactionalDataCollections 2 params → 200
GET
/v2/contacts/score
Gets a list of contact scoring data.
ApiContact_GetContactsScore 2 params → 200
GET
/v2/address-books/{addressBookId}/contacts/score
Gets a list of contact scoring data in specified list.
ApiContact_GetContactsScoreInAddressBook 3 params → 200
GET
/v2/contacts/score/modified-since/{date}
Gets a list of contact scoring data ordered by modified date.
ApiContact_GetContactsScoreModifiedSinceDate 3 params → 200
GET
/v2/contacts/{email}/score
Gets particular contact scoring data.
ApiContact_GetContactScoreByEmail 1 param → 200
GET
/v2/contacts/{id}/score
Gets particular contact scoring data.
ApiContact_GetContactScoreByContactId 1 param → 200
GET
/v2/contacts/count
Gets the total number of contacts in an account.
ApiContact_GetAllContactsCount → 200
GET
/v2/contacts/retrieve-collection
Gets a batch of contacts by ID or email address.
ApiContact_GetMultipleContacts body → 200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are ApiPreference (12 properties), ApiContactScore (7 properties), ApiContact (6 properties), ApiTransactionalDataImportReport (4 properties). Each schema is shown below with its type and property counts.

ApiResubscribeResult
object
2 properties
ApiResubscribeStatuses
string
ApiTransactionalDataImportStatuses
string
ApiContactScore
object
7 properties
ApiContact
object
6 properties 1 required
ApiBulkContactDeletionStatuses
string
ApiMultipleContactsRequest
object
2 properties
ApiBulkSuppressResponse
object
2 properties
ApiContactEmailTypes
string
ApiTransactionalDataImportReportFault
object
3 properties
ApiMultipleContactsResponse
object
2 properties
ApiConsent
object
2 properties
ApiContactIdAndEmail
object
2 properties
ApiBulkContactDeletion
object
2 properties
ApiTransactionalDataImportFaultReason
string
ApiContactResubscription
object
3 properties 1 required
ApiTransactionalDataImport
object
2 properties
ApiTransactionalDataCollection
object
2 properties
ApiContactExtended
ApiPreference
object
12 properties
ApiTransactionalData
object
3 properties
ApiContactSuppression
object
3 properties
ApiContactWithConsent
object
2 properties
ApiContactStatuses
string
ApiContactData
object
2 properties
ApiTransactionalDataImportReport
object
4 properties
ApiJsonData
object
1 property
ApiContactWithConsentAndPreferences
ApiContactOptInTypes
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dotdigital-apicontact-api-openapi.yml Raw ↑

Other APIs Dotdigital publishes across the network.

Dotdigital Marketing Developer Hub MCP Server
Dotdigital Accounts and Utilities API
Dotdigital API Account API
Dotdigital API Address Book API
Dotdigital API Campaign API
Dotdigital API Campaign From Address API
Dotdigital API Campaign Reporting API
Dotdigital API Campaign Send API
Dotdigital API Contact Import API
Dotdigital API Data Field API
Dotdigital API Document API
Dotdigital API Ecommerce API
Where this information came from

This is an independent, third-party profile of Dotdigital API Contact API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.