Dotdigital

Dotdigital Segments API

The Segments API from Dotdigital — 2 operation(s) for segments.

GitHub OpenAPI

Operations 3

GET /v2/segments Get segments #
POST /v2/segments/refresh/{id} Refresh segment #
GET /v2/segments/refresh/{id} Get refresh progress for segment #

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-segments-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-segments-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-segments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Segments API
  description: 'Retrieve and manage contact segments. Use this API to list all segments with

    their current contact counts, trigger a refresh of a segment''s membership, and

    check the progress of an in-flight refresh.'
  version: 2.0.1
servers:
- url: https://{region}-api.dotdigital.com
  variables:
    region:
      default: r1
      enum:
      - r1
      - r2
      - r3
      description: The Dotdigital region id your account belongs to
security:
- basicAuth: []
tags:
- name: Segments
paths:
  /v2/segments:
    parameters:
    - in: header
      name: x-ddg-integration-token
      required: false
      description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
      schema:
        type: string
        pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
        example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
    get:
      summary: Get segments
      deprecated: false
      description: Gets all segments
      operationId: get-segments
      tags:
      - Segments
      parameters: []
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      default: 0
                      examples:
                      - 1
                    name:
                      type: string
                      examples:
                      - Test
                    contacts:
                      type: integer
                      default: 0
                      examples:
                      - 5
              examples:
                Result:
                  summary: Result
                  value:
                  - id: 1
                    name: Test
                    contacts: 5
                  - id: 2
                    name: Contacts who opened campaign X
                    contacts: 7
                  - id: 3
                    name: First Stream who have not opened a campaign
                    contacts: 7
                  - id: 4
                    name: Professionals who have opened a campaign
                    contacts: 6
  /v2/segments/refresh/{id}:
    parameters:
    - in: header
      name: x-ddg-integration-token
      required: false
      description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
      schema:
        type: string
        pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
        example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
    post:
      summary: Refresh segment
      deprecated: false
      description: Refreshes a segment by ID
      operationId: refresh-segment
      tags:
      - Segments
      parameters:
      - name: id
        in: path
        description: The ID of the segment you want to refresh.
        required: true
        example: 0
        schema:
          type: integer
          format: int32
      responses:
        '202':
          description: '202'
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    default: 0
                    examples:
                    - 1
                  status:
                    type: string
                    examples:
                    - NotStarted
              examples:
                Result:
                  summary: Result
                  value:
                    id: 1
                    status: NotStarted
    get:
      summary: Get refresh progress for segment
      deprecated: false
      description: Gets the refresh progress for a segment
      operationId: get-refresh-progress-for-segment
      tags:
      - Segments
      parameters:
      - name: id
        in: path
        description: The ID of the segment you want to get the refresh progress for.
        required: true
        example: 0
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    default: 0
                    examples:
                    - 1
                  status:
                    type: string
                    examples:
                    - Finished
              examples:
                Result:
                  summary: Result
                  value:
                    id: 1
                    status: Finished
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Learn more about Dotdigital APIs
  url: https://developer.dotdigital.com
x-readme:
  headers: []
  explorer-enabled: true
  proxy-enabled: true
x-readme-fauxas: true
x-samples-languages:
- curl
- csharp
- java
- javascript
- node
- python
- php
- ruby