Dotdigital

Dotdigital API Address Book API

The ApiAddressBook API from Dotdigital — 6 operation(s) for apiaddressbook.

GitHub OpenAPI

Operations 9

GET /v2/address-books/{id} Gets a list by ID. #
PUT /v2/address-books/{id} Updates a list. #
DELETE /v2/address-books/{id} Deletes a list. #
GET /v2/address-books Gets all lists. #
POST /v2/address-books Creates a list. #
GET /v2/address-books/private Gets all private lists. #
GET /v2/address-books/public Gets all public lists. #
GET /v2/contacts/{contactId}/address-books Gets any lists that a contact is in. #
GET /v2/campaigns/{campaignId}/address-books Gets any lists that a campaign has ever been sent to. #

Documentation

📖
Documentation
https://marketing.developer.dotdigital.com/docs/getting-started-with-the-api
📖
APIReference
https://marketing.developer.dotdigital.com/reference/
📖
Documentation
https://marketing.developer.dotdigital.com/docs/api-end-points
📖
APIReference
https://marketing.developer.dotdigital.com/reference/unified-contacts
📖
Documentation
https://marketing.developer.dotdigital.com/reference/omnichannel-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dotdigital/refs/heads/main/openapi/dotdigital-apiaddressbook-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/dotdigital-apiaddressbook-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

dotdigital-apiaddressbook-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: apiconnector.com API Address Book API
  version: v2
servers:
- url: https://r1-api.dotdigital.com
tags:
- name: ApiAddressBook
paths:
  /v2/address-books/{id}:
    get:
      tags:
      - ApiAddressBook
      summary: Gets a list by ID.
      operationId: ApiAddressBook_GetAddressBookById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiAddressBook'
    put:
      tags:
      - ApiAddressBook
      summary: Updates a list.
      operationId: ApiAddressBook_UpdateAddressBook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 1
      requestBody:
        x-name: apiAddressBook
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiAddressBook'
        required: true
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiAddressBook'
    delete:
      tags:
      - ApiAddressBook
      summary: Deletes a list.
      operationId: ApiAddressBook_DeleteAddressBook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
  /v2/address-books:
    get:
      tags:
      - ApiAddressBook
      summary: Gets all lists.
      operationId: ApiAddressBook_GetAddressBooks
      parameters:
      - name: select
        in: query
        schema:
          type: integer
          format: int32
          default: 1000
        x-position: 1
      - name: skip
        in: query
        schema:
          type: integer
          format: int32
          default: 0
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiAddressBook'
    post:
      tags:
      - ApiAddressBook
      summary: Creates a list.
      operationId: ApiAddressBook_CreateAddressBook
      requestBody:
        x-name: apiAddressBook
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiAddressBook'
        required: true
        x-position: 1
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiAddressBook'
  /v2/address-books/private:
    get:
      tags:
      - ApiAddressBook
      summary: Gets all private lists.
      operationId: ApiAddressBook_GetPrivateAddressBooks
      parameters:
      - name: select
        in: query
        schema:
          type: integer
          format: int32
          default: 1000
        x-position: 1
      - name: skip
        in: query
        schema:
          type: integer
          format: int32
          default: 0
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiAddressBook'
  /v2/address-books/public:
    get:
      tags:
      - ApiAddressBook
      summary: Gets all public lists.
      operationId: ApiAddressBook_GetPublicAddressBooks
      parameters:
      - name: select
        in: query
        schema:
          type: integer
          format: int32
          default: 1000
        x-position: 1
      - name: skip
        in: query
        schema:
          type: integer
          format: int32
          default: 0
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiAddressBook'
  /v2/contacts/{contactId}/address-books:
    get:
      tags:
      - ApiAddressBook
      summary: Gets any lists that a contact is in.
      operationId: ApiAddressBook_GetAddressBooksForContact
      parameters:
      - name: contactId
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: select
        in: query
        schema:
          type: integer
          format: int32
          default: 1000
        x-position: 2
      - name: skip
        in: query
        schema:
          type: integer
          format: int32
          default: 0
        x-position: 3
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiAddressBook'
  /v2/campaigns/{campaignId}/address-books:
    get:
      tags:
      - ApiAddressBook
      summary: Gets any lists that a campaign has ever been sent to.
      operationId: ApiAddressBook_GetAddressBooksForCampaign
      parameters:
      - name: campaignId
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: select
        in: query
        schema:
          type: integer
          format: int32
          default: 1000
        x-position: 2
      - name: skip
        in: query
        schema:
          type: integer
          format: int32
          default: 0
        x-position: 3
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiAddressBook'
components:
  schemas:
    ApiAddressBook:
      type: object
      additionalProperties: false
      required:
      - name
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
          minLength: 1
        visibility:
          $ref: '#/components/schemas/ApiAddressBookVisibility'
        contacts:
          type: integer
          format: int32
    ApiAddressBookVisibility:
      type: string
      description: ''
      x-enumNames:
      - Private
      - Public
      - NotAvailableInThisVersion
      enum:
      - Private
      - Public
      - NotAvailableInThisVersion
x-generator: NSwag v14.4.0.0 (NJsonSchema v11.3.2.0 (Newtonsoft.Json v13.0.0.0))