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 Lists / Address books API

The Lists / Address books API from Dotdigital — 14 operation(s) for lists / address books.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 17 operations across 14 paths. It is described by OpenAPI 3.2.0, at version 2.0.2.

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

17 operations 14 paths 0 schemas 2 DELETE8 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 17

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

Lists / Address books 17
GET
/v2/address-books/{id}/campaigns
Get campaigns sent to address book or segment
get-campaigns-sent-to-address-book-or-segment 4 params → 200
POST
/v2/address-books
Create list
create-address-book 1 param body → 200
GET
/v2/address-books
Get lists
get-address-books 3 params → 200
DELETE
/v2/address-books/{id}
Delete list
delete-address-book 2 params → 204
PUT
/v2/address-books/{id}
Update list
update-address-book 2 params body → 200
GET
/v2/address-books/{id}
Get list
get-address-book 2 params → 200
GET
/v2/address-books/private
Get private lists
get-private-address-books 3 params → 200
GET
/v2/address-books/public
Get public lists
get-public-address-books 3 params → 200
GET
/v2/address-books/{id}/contacts/unsubscribed-since/{date}
Get unsubscribed from list since date
get-unsubscribed-contacts-from-address-book-since-date 5 params → 200
POST
/v2/address-books/{id}/contacts/unsubscribe
Unsubscribe contact from list
unsubscribe-contact-from-address-book 2 params body → 200
POST
/v2/address-books/{id}/contacts/resubscribe
Resubscribe contact to list
resubscribe-contact-to-address-book 2 params body → 200
POST
/v2/address-books/{id}/contacts/resubscribe-with-no-challenge
Resubscribe contact to list with no challenge
resubscribe-contact-to-address-book-with-no-challenge 2 params body → 200
DELETE
/v2/address-books/{addressBookId}/contacts/{contactId}
Delete contact from list
delete-contact-from-address-book 3 params → 204
POST
/v2/address-books/{addressBookId}/contacts/delete
Delete contacts from list
delete-contacts-from-address-book 2 params body → 202
POST
/v2/address-books/{addressBookId}/contacts/delete-all
Delete all contacts from list
delete-all-contacts-from-address-book 2 params → 202
GET
/v2/address-books/{addressBookId}/contacts/with-preference/{preferenceId}
Get contacts opted into a preference and an address book
get-contacts-opted-into-a-preference-and-an-address-book 4 params → 200
GET
/v2/address-books/{addressBookId}/contacts/with-preference/{preferenceId}/opt-ins-since/{date}
Get contacts with modified preference opt-in in address book since date
get-contacts-with-modified-preference-opt-in-in-address-book-since-date 5 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dotdigital-lists-address-books-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
#Lists / Address books
← Back to D APIs
API Details
ID
dotdigital:dotdigital-lists-address-books-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-lists-address-books-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/dotdigital-lists-address-books-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 Lists / Address books 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.