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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Dotdigital

Dotdigital Contacts API

The Contacts API from Dotdigital — 6 operation(s) for contacts.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 10 operations across 6 paths, and defines 59 schemas. It is described by OpenAPI 3.2.0, at version 3.4.3.

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

10 operations 6 paths 59 schemas 1 DELETE4 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Dotdigital Contacts API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Contacts 10
GET
/contacts/v3
Get contacts based on your criteria
getContacts 9 params → 200400401
POST
/contacts/v3
Create a contact
createContact 1 param body → 201400401409
POST
/contacts/v3/delete
Delete multiple contacts
deleteContacts 1 param body → 202400401429
GET
/contacts/v3/delete/{deleteId}
Get the status of a delete contacts job
getDeleteStatus 1 param → 200400401404
PUT
/contacts/v3/import
Import contact collection
importContacts 1 param body → 202400401429
GET
/contacts/v3/import/{importId}
Get the status of a contacts import request
getImportStatus 1 param → 200400401404
GET
/contacts/v3/{identifier}/{value}
Get a contact by an identifier
getContact 3 params → 200400401404
PUT
/contacts/v3/{identifier}/{value}
Replace a contact
replaceContact 3 params body → 200400401404
DELETE
/contacts/v3/{identifier}/{value}
Deletes a contact using a specific identifier
deleteContact 3 params → 200400401404
PATCH
/contacts/v3/{identifier}/{value}
Import a single contact
importContact 4 params body → 200201400401409

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are inline_response_200_2 (6 properties), inline_response_200_1 (5 properties), paginationLinks (5 properties), inline_response_200_2_summary (5 properties). Each schema is shown below with its type and property counts.

inline_response_200_1_failures_1
object
Contact delete failure summary
2 properties 2 required
paginationLinks
object
Pagination links
5 properties 2 required
channelProperties_channelProperties
object
Properties associated with each channel for a contact. For example, message format or subscription status
3 properties
inline_response_200_2
object
6 properties 2 required
createContactRequest
paginationLinks_last
object
Details for accessing the last pages worth of data
2 properties 2 required
channelPropertiesWithResubscribe_channelProperties
object
1 property
inline_response_202
object
1 property
channelStatusUpdate
string
The subscription status for the channel; if not specified it remains unaltered for existing contacts, and for new contacts this defaults to values defined in S…
errorResponse_details
object
2 properties 2 required
inline_response_200_2_failures_1
object
Contact import failure summary
4 properties 3 required
contact_channelProperties_sms
object
2 properties 2 required
contactBasicDetails
object
5 properties 5 required
v3_import_body
object
2 properties 1 required
preferenceFull
object
4 properties 3 required
contactReference
object
Contact reference
2 properties 2 required
whatsAppChannelStatus
string
The current status for the WhatsApp channel for this contact
contact_channelProperties
object
Properties associated with each channel for a contact. For exmaple, message format or subscription status.
3 properties
emailChannelStatus
string
Current status of the email channel for the contact
channelProperties_channelProperties_email
object
The channel properties for email
3 properties
consentRecordsToBeInserted
array
The marketing consent records to be associated with the contact
inline_response_202_1
object
1 property
inline_response_200_1_summary
object
4 properties 4 required
identifiers
object
Identifiers this contact can be referenced by
2 properties
inline_response_200_3
object
The contact id of the deleted contact
1 property 1 required
contact_channelProperties_email
object
3 properties 3 required
inline_response_200
object
2 properties 2 required
contact
optInType
string
Channel opt-in type for the contact
updateContactRequest
baseContact
channelProperties_channelProperties_whatsApp
object
The channel properties for WhatsApp
1 property
paginationLinks_next
object
Details for accessing the next pages worth of data
2 properties 2 required
contactRequest
contact_channelProperties_whatsApp
object
1 property 1 required
contact_lists
object
3 properties 3 required
channelPropertiesWithResubscribe
object
1 property
channelPropertiesWithResubscribe_channelProperties_email
object
1 property
contactIdentifier
contactId
integer
Immutable unique identifier for the contact
inline_response_200_1
object
5 properties 2 required
errorResponse
object
3 properties 2 required
channelPropertiesWithResubscribe_channelProperties_email_resubscribeOptions
object
3 properties
smsChannelStatus
string
The current status for the SMS channel for this contact
inline_response_200_2_failures
object
A failure reason
2 properties 2 required
channelProperties_channelProperties_sms
object
The channel properties for SMS/MMS
1 property
paginationLinks_first
object
Details for accessing the first page worth of data
2 properties 2 required
consentRecords
array
Marketing consent records associated with the contact
contactIdObject
object
1 property
baseContactRequest
paginationLinks_self
object
Details for accessing this data page via pagination
2 properties 2 required
replaceContactRequest
channelProperties
object
1 property
inline_response_200_1_failures
object
A failure reason
2 properties 2 required
inline_response_200_2_summary
object
5 properties
status
string
The opt in status for the contact
preference
object
2 properties 2 required
consentRecord
object
Marketing consent records to be associated with the contact
5 properties 5 required
paginationLinks_prev
object
Details for accessing the previous pagea worth of data
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dotdigital-contacts-api-openapi.yml Raw ↑

Other APIs Dotdigital publishes across the network.

Dotdigital Marketing Developer Hub MCP Server
AE Profile APIs.io
Dotdigital Accounts and Utilities API
AE Profile APIs.io
Dotdigital API Account API
AE Profile APIs.io
Dotdigital API Address Book API
AE Profile APIs.io
Dotdigital API Campaign API
AE Profile APIs.io
Dotdigital API Campaign From Address API
AE Profile APIs.io
Dotdigital API Campaign Reporting API
AE Profile APIs.io
Dotdigital API Campaign Send API
AE Profile APIs.io
Dotdigital API Contact API
AE Profile APIs.io
Dotdigital API Contact Import API
AE Profile APIs.io
Dotdigital API Data Field API
AE Profile APIs.io
Dotdigital API Document API
AE Profile APIs.io
#Contacts
← Back to D APIs
API Details
ID
dotdigital:dotdigital-contacts-api
Base URL
https://r1-api.dotdigital.com/v2
Docs
https://marketing.developer.dotdigital.com/docs/getting-started-with-the-api
Provider
Dotdigital
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=dotdigital-contacts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/dotdigital-contacts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Dotdigital Contacts 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.