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 Preference API

The ApiPreference API from Dotdigital — 14 operation(s) for apipreference.

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

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

This API exposes 18 operations across 14 paths, and defines 9 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.

18 operations 14 paths 9 schemas 1 DELETE11 GET1 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 18

Across 14 paths, the API surfaces 18 operations — 1 DELETE, 11 GET, 1 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

ApiPreference 18
GET
/v2/preferences
Gets the preferences, as a tree structure.
ApiPreference_GetPreferences → 200
POST
/v2/preferences
Creates a new preference or a new preference category.
ApiPreference_CreatePreference body → 200
GET
/v2/preferences/modified-since/{sinceDate}
Gets an array of preferences that have been modified since the specified date.
ApiPreference_GetPreferencesSinceDate 1 param → 200
PUT
/v2/preferences/{id}
Update the preference with the specified Id.
ApiPreference_UpdatePreference 1 param body → 200
DELETE
/v2/preferences/{id}
Deletes the preference with the specified Id.
ApiPreference_DeletePreference 1 param → 200
GET
/v2/contacts/with-preference/{preferenceId}
Gets a list of contacts subscribed to the specified preference.
ApiPreference_GetContactsWithPreference 2 params → 200
GET
/v2/address-books/{bookId}/contacts/with-preference/{preferenceId}
Gets a list of contacts from a given list, subscribed to the specified preference.
ApiPreference_GetContactsInAddressBookWithPreference 3 params → 200
PUT
/v2/contacts/{contactId}/preferences
Sets the subscribed preferences for a contact
ApiPreference_SetPreferencesForContact 1 param body → 200
PUT
/v2/contact/{contactId}/preferences
Sets the subscribed preferences for a contact
ApiPreference_SetPreferencesForContact2 1 param body → 200
PUT
/v2/contacts/{contactEmail}/preferences
Sets the subscribed preferences for a contact
ApiPreference_SetPreferencesForContact3 1 param body → 200
GET
/v2/contacts/{contactEmail}/preferences
Gets the preferences for the specified contact
ApiPreference_GetPreferencesForContact 1 param → 200
PUT
/v2/contact/{contactEmail}/preferences
Sets the subscribed preferences for a contact
ApiPreference_SetPreferencesForContact4 1 param body → 200
GET
/v2/contact/{contactEmail}/preferences
Gets the preferences for the specified contact
ApiPreference_GetPreferencesForContact2 1 param → 200
GET
/v2/contacts/{contactID}/preferences
Gets the preferences for the specified contact
ApiPreference_GetPreferencesForContact3 1 param → 200
GET
/v2/contact/{contactID}/preferences
Gets the preferences for the specified contact
ApiPreference_GetPreferencesForContact4 1 param → 200
GET
/v2/contacts/{contactEmail}/subscriptions
Gets the subscriptions for the specified contact
ApiPreference_GetSubscriptionsForContact 1 param → 200
GET
/v2/contacts/with-preference/{preferenceId}/opt-ins-since/{sinceDate}
Gets a list of contacts who have opted in to a preference since the specified date
ApiPreference_GetModifiedPreferenceOptIns 3 params → 200
GET
/v2/address-books/{bookId}/contacts/with-preference/{preferenceId}/opt-ins-since/{sinceDate}
Gets a list of contacts, from a given list, who have opted in to a preference, since the specified date
ApiPreference_GetModifiedPreferenceOptInsByAddressBook 4 params → 200

Schemas 9

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

ApiContactStatuses
string
ApiContactData
object
2 properties
ApiPreference
object
12 properties
ApiContact
object
6 properties 1 required
ApiContactWithPreferenceOptIn
object
2 properties
ApiContactIdAndEmail
object
2 properties
ApiMarketingPreferenceOptIn
object
4 properties
ApiContactEmailTypes
string
ApiContactOptInTypes
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dotdigital-apipreference-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 API
Dotdigital API Contact Import API
Dotdigital API Data Field API
Dotdigital API Document API
Where this information came from

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