Dotdigital

Dotdigital Cpaas API

The Cpaas API from Dotdigital — 41 operation(s) for cpaas.

GitHub OpenAPI

Operations 73

GET /cpaas/chat/config Retrieves the chat configuration for an apiSpace
GET /cpaas/chat/config/teams/{teamId} Retrieves the members of a team
DELETE /cpaas/chat/config/teams/{teamId} Removes the config for a team
PUT /cpaas/chat/config/teams/{teamId}/appMessaging Update the App Messaging config for a team
DELETE /cpaas/chat/config/teams/{teamId}/appMessaging Removes the App Messaging config for a team
PUT /cpaas/chat/config/teams/{teamId}/settings Update general settings for a team
DELETE /cpaas/chat/config/teams/{teamId}/settings Removes the settings for a team
GET /cpaas/chats/{chatId}/events Retrieves a chat's events
GET /cpaas/chats/{chatId}/messages Retrieves a chat's messages from an point (event) in time and works backwards
POST /cpaas/chats/{chatId}/messages Sends a message to chat
POST /cpaas/chats/{chatId}/messages/statusupdates Posts message updates back
GET /cpaas/chats/{chatId} Retrieves a chat
PUT /cpaas/chats/{chatId} Updates a chat
DELETE /cpaas/chats/{chatId} Deletes a chat
PUT /cpaas/chats/{chatId}/assign Assigns a chat
PUT /cpaas/chats/{chatId}/close Closes a chat
PUT /cpaas/chats/{chatId}/channel Changes the channel for an existing chat
POST /cpaas/chats/{chatId}/form Sends a form to a chat
GET /cpaas/chats Retrieves a list of chats
POST /cpaas/chats Creates a new chat
POST /cpaas/chats/{chatId}/typing Indicates that the caller is typing in this chat
DELETE /cpaas/chats/{chatId}/typing Indicates that the caller has stopped typing in this chat
GET /cpaas/chats/{chatId}/participants Retrieves the chat participants
GET /cpaas/presence Retrieves the presence for a list of agent's profileIds
GET /cpaas/presence/appmessaging Retrieves the presence for a list of user's profileIds
POST /cpaas/content Upload a file
GET /cpaas/content/{fileId} Retrieve a file
DELETE /cpaas/content/{fileId} Delete a file
GET /cpaas/conversations/{conversationId}/events Retrieves a conversation's events
GET /cpaas/conversations/{conversationId}/messages Retrieves a conversation's messages from an point (event) in time and works backwards
POST /cpaas/conversations/{conversationId}/messages Sends a message to conversation
POST /cpaas/conversations/{conversationId}/messages/statusupdates Posts message updates back
GET /cpaas/conversations/{conversationId} Retrieves a conversation
PUT /cpaas/conversations/{conversationId} Updates a conversation
DELETE /cpaas/conversations/{conversationId} Deletes a conversation
GET /cpaas/conversations Retrieves a list of conversations
POST /cpaas/conversations Creates a new conversation
POST /cpaas/conversations/{conversationId}/typing Indicates that the caller is typing in this conversation
DELETE /cpaas/conversations/{conversationId}/typing Indicates that the caller has stopped typing in this conversation
GET /cpaas/conversations/{conversationId}/participants Retrieves the conversation participants
POST /cpaas/conversations/{conversationId}/participants Adds a list of participants to a conversation
DELETE /cpaas/conversations/{conversationId}/participants Deletes a list of participants from a conversation
GET /cpaas/profiles/{profileId}/messages Retrieves message history for the specified profile. Messages retrieved from the date spacified (default now), in descending time order.
GET /cpaas/automation/inboundrules Retrieves a message rules configuration list
POST /cpaas/automation/inboundrules Create a message rule configuration
GET /cpaas/automation/inboundrules/{messageRulesId} Retrieves single message rule configuration
PUT /cpaas/automation/inboundrules/{messageRulesId} Update single message rule configuration
DELETE /cpaas/automation/inboundrules/{messageRulesId} Delete single message rule configuration
POST /cpaas/profiles/export Exports the result of a profile query in a formatted file for download
DELETE /cpaas/profiles/bulk Deletes the requested profiles
PATCH /cpaas/profiles/bulk Creates or updates the supplied profiles with the supplied data
GET /cpaas/profiles/{id} Retrieves a Profile
PUT /cpaas/profiles/{id} Updates or undeletes a Profile
DELETE /cpaas/profiles/{id} Deletes a Profile
PATCH /cpaas/profiles/{id} Patches a Profile
PUT /cpaas/profiles/{id}/optin Set profile opt in for specified channels
DELETE /cpaas/profiles/{id}/optin Set profile opt in for specified channels
PUT /cpaas/profiles/{id}/rels/primary/{linkedId} Creates a relationship where the linked profile is the primary and this profile is a child
DELETE /cpaas/profiles/{id}/rels/primary/{linkedId} Deletes the profile's relationship to a primary profile
PUT /cpaas/profiles/{id}/rels/link/{linkedId} Creates a relationship where this profile is the primary and the linked profile is a child
DELETE /cpaas/profiles/{id}/rels/link/{linkedId} Deletes the primary profile's relationship to a linked Profile
GET /cpaas/profiles Query profiles
POST /cpaas/profiles Creates a new Profile
GET /cpaas/profiles/optin Gets default profiles opt in/out options for each channel in channel service
PUT /cpaas/profiles/optin Set default profiles opt in/out options for each channel in channel service
GET /cpaas/sessions/tokens/anon Gets a token that can be used to start an anonymous session
GET /cpaas/sessions/{id} Retrieves details about a session
DELETE /cpaas/sessions/{id} Ends a session, revoking access to services.
GET /cpaas/templates Retrieves a list of all available templates
POST /cpaas/templates Create a template
GET /cpaas/templates/{templateId} Retrieves a template
PUT /cpaas/templates/{templateId} Updates a template
DELETE /cpaas/templates/{templateId} Deletes a template

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-cpaas-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-cpaas-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-cpaas-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Dotdigital Cpaas API
  version: '1.0'
  description: 'Operations tagged Cpaas across 12 of this provider''s published API definitions: dotdigital-chat-config-openapi.yml, dotdigital-chat-message-openapi.yml, dotdigital-chat-openapi.yml, dotdigital-chat-presence-openapi.yml, dotdigital-content-openapi.yml, dotdigital-conversation-message-openapi.yml, dotdigital-conversation-openapi.yml, dotdigital-message-history-openapi.yml, dotdigital-message-rules-openapi.yml, dotdigital-profile-openapi.yml, dotdigital-session-openapi.yml, dotdigital-templates-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{region}-api.dotdigital.com
  variables:
    region:
      default: r1
      enum:
      - r1
      - r2
      - r3
      description: The Dotdigital region id your account belongs to
- url: http://{region}-api.dotdigital.com/v2
  variables:
    region:
      description: The Dotdigital region id your account belongs to
      enum:
      - r1
      - r2
      - r3
      default: r1
security:
- basicAuth: []
tags:
- name: Cpaas
paths:
  /cpaas/chat/config:
    get:
      summary: Retrieves the chat configuration for an apiSpace
      responses:
        '200':
          description: The full team details
          headers:
            ETag:
              description: A unique value representing the version of the configuration, optionally used for optimistic concurrency control on PUT and DELETE
              schema:
                type: string
            Last-Modified:
              description: The date the team was last updated in ISO 8601 format
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configFull'
        '404':
          description: The team was not found
          content: {}
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          default: r1
          enum:
          - r1
          - r2
          - r3
          description: The Dotdigital region id your account belongs to
  /cpaas/chat/config/teams/{teamId}:
    get:
      summary: Retrieves the members of a team
      parameters:
      - name: teamId
        in: path
        description: The Team id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The team member details
          headers:
            ETag:
              description: A unique value representing the version of the configuration, optionally used for optimistic concurrency control on PUT and DELETE
              schema:
                type: string
            Last-Modified:
              description: The date the team was last updated in ISO 8601 format
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamMembers'
        '404':
          description: The team was not found
          content: {}
      tags:
      - Cpaas
    delete:
      summary: Removes the config for a team
      parameters:
      - name: teamId
        in: path
        description: The Team ID
        required: true
        schema:
          type: string
      - name: if-match
        in: header
        description: An optional ETag for optimistic concurrency control
        schema:
          type: string
      responses:
        '200':
          description: The config was removed for the team
          content: {}
        '404':
          description: The team was not found, or did not have any config already
          content: {}
        '412':
          description: The ETag supplied did not match, another update may have taken place
          content: {}
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          default: r1
          enum:
          - r1
          - r2
          - r3
          description: The Dotdigital region id your account belongs to
  /cpaas/chat/config/teams/{teamId}/appMessaging:
    put:
      summary: Update the App Messaging config for a team
      parameters:
      - name: teamId
        in: path
        description: The Team id
        required: true
        schema:
          type: string
      - name: if-match
        in: header
        description: An optional ETag for optimistic concurrency control
        schema:
          type: string
      requestBody:
        description: The App Messaging config to update for the team
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/appMessagingConfig'
        required: true
      responses:
        '200':
          description: The full team details
          headers:
            ETag:
              description: A unique value representing the version of the configuration, optionally used for optimistic concurrency control on PUT and DELETE
              schema:
                type: string
            Last-Modified:
              description: The date the configuration was last updated in ISO 8601 format
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appMessagingConfig'
        '404':
          description: The team was not found
          content: {}
        '412':
          description: The ETag supplied did not match, another update may have taken place
          content: {}
      x-codegen-request-body-name: body
      tags:
      - Cpaas
    delete:
      summary: Removes the App Messaging config for a team
      parameters:
      - name: teamId
        in: path
        description: The Team ID
        required: true
        schema:
          type: string
      - name: if-match
        in: header
        description: An optional ETag for optimistic concurrency control
        schema:
          type: string
      responses:
        '200':
          description: The App Messaging config was removed for the team
          content: {}
        '404':
          description: The team was not found, or did not have any config already
          content: {}
        '412':
          description: The ETag supplied did not match, another update may have taken place
          content: {}
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          default: r1
          enum:
          - r1
          - r2
          - r3
          description: The Dotdigital region id your account belongs to
  /cpaas/chat/config/teams/{teamId}/settings:
    put:
      summary: Update general settings for a team
      parameters:
      - name: teamId
        in: path
        description: The Team id
        required: true
        schema:
          type: string
      - name: if-match
        in: header
        description: An optional ETag for optimistic concurrency control
        schema:
          type: string
      requestBody:
        description: The settings to update for the team
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/settings'
        required: true
      responses:
        '200':
          description: The full team details
          headers:
            ETag:
              description: A unique value representing the version of the configuration, optionally used for optimistic concurrency control on PUT and DELETE
              schema:
                type: string
            Last-Modified:
              description: The date the team was last updated in ISO 8601 format
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/settings'
        '404':
          description: The team was not found
          content: {}
        '412':
          description: The ETag supplied did not match, another update may have taken place
          content: {}
      x-codegen-request-body-name: body
      tags:
      - Cpaas
    delete:
      summary: Removes the settings for a team
      parameters:
      - name: teamId
        in: path
        description: The Team ID
        required: true
        schema:
          type: string
      - name: if-match
        in: header
        description: An optional ETag for optimistic concurrency control
        schema:
          type: string
      responses:
        '200':
          description: The general settings were removed for the team
          content: {}
        '404':
          description: The team was not found, or did not have any config already
          content: {}
        '412':
          description: The ETag supplied did not match, another update may have taken place
          content: {}
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          default: r1
          enum:
          - r1
          - r2
          - r3
          description: The Dotdigital region id your account belongs to
  /cpaas/chats/{chatId}/events:
    get:
      summary: Retrieves a chat's events
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      - name: from
        in: query
        description: The event id to start from
        required: true
        schema:
          minimum: 0
          type: integer
      - name: limit
        in: query
        description: The number of events to read forward
        required: true
        schema:
          minimum: 0
          type: integer
      responses:
        '200':
          description: A list of chat events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MessageEvent'
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/chats/{chatId}/messages:
    get:
      summary: Retrieves a chat's messages from an point (event) in time and works backwards
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      - name: from
        in: query
        description: The event id to work backwards from
        required: false
        schema:
          minimum: 0
          type: integer
      - name: limit
        in: query
        description: The number of messages to return
        required: true
        schema:
          maximum: 100
          minimum: 1
          type: integer
      responses:
        '200':
          description: A list of partial and the requested number of complete messages, aggregated from the chat events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResult'
      tags:
      - Cpaas
    post:
      summary: Sends a message to chat
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      requestBody:
        description: Detail of the message to send
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessagePost'
        required: true
      responses:
        '200':
          description: The message was successfully sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagePostResult'
      x-codegen-request-body-name: message
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/chats/{chatId}/messages/statusupdates:
    post:
      summary: Posts message updates back
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      requestBody:
        description: Details of the message status updates
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/MessageStatusUpdate'
        required: true
      responses:
        '200':
          description: The status updates were successfully received
          content: {}
      x-codegen-request-body-name: updates
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/chats/{chatId}:
    get:
      summary: Retrieves a chat
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      - name: includeDeleted
        in: query
        description: Indicates whether deleted chats should be returned
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: The requested chat
          headers:
            ETag:
              description: A unique value representing the version of the chat, optionally used for optimistic concurrency control on PUT and DELETE
              schema:
                type: string
            Last-Modified:
              description: The date the chat was last updated in ISO 8601 format
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chat'
        '404':
          description: The chat was not found
          content: {}
      tags:
      - Cpaas
    put:
      summary: Updates a chat
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      - name: if-match
        in: header
        description: An optional ETag for optimistic concurrency control
        required: false
        schema:
          type: string
      requestBody:
        description: Detail of the chat to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatUpdate'
        required: true
      responses:
        '200':
          description: The updated chat
          headers:
            ETag:
              description: A unique value representing the version of the chat, optionally used for optimistic concurrency control on PUT and DELETE
              schema:
                type: string
            Last-Modified:
              description: The date the chat was last updated in ISO 8601 format
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chat'
        '400':
          description: Validation issues were found
          content: {}
        '404':
          description: The chat was not found
          content: {}
        '409':
          description: A conncurrency issue occured updating the chat
          content: {}
        '412':
          description: The specified 'if-match' header was not valid, refresh and retry
          content: {}
      x-codegen-request-body-name: name
      tags:
      - Cpaas
    delete:
      summary: Deletes a chat
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      - name: if-match
        in: header
        description: An optional ETag for optimistic concurrency control
        required: false
        schema:
          type: string
      responses:
        '204':
          description: Indicates successful deletetion of an chat
          content: {}
        '404':
          description: The chat was not found
          content: {}
        '409':
          description: A conncurrency issue occured deleting the chat
          content: {}
        '412':
          description: The specified 'if-match' header was not valid, refresh and retry
          content: {}
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/chats/{chatId}/assign:
    put:
      summary: Assigns a chat
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      - name: if-match
        in: header
        description: An optional ETag for optimistic concurrency control
        required: false
        schema:
          type: string
      requestBody:
        description: Detail of the agent to assign the chat to
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignmentDetails'
        required: true
      responses:
        '200':
          description: The updated chat
          headers:
            ETag:
              description: A unique value representing the version of the chat, optionally used for optimistic concurrency control on PUT and DELETE
              schema:
                type: string
            Last-Modified:
              description: The date the chat was last updated in ISO 8601 format
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chat'
        '400':
          description: Validation issues were found
          content: {}
        '404':
          description: The chat was not found
          content: {}
        '409':
          description: A conncurrency issue occured updating the chat
          content: {}
        '412':
          description: The specified 'if-match' header was not valid, refresh and retry
          content: {}
      x-codegen-request-body-name: assignment
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/chats/{chatId}/close:
    put:
      summary: Closes a chat
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      - name: if-match
        in: header
        description: An optional ETag for optimistic concurrency control
        required: false
        schema:
          type: string
      requestBody:
        description: Options relating to closing the chat.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chatId_close_body'
        required: false
      responses:
        '200':
          description: The updated chat
          headers:
            ETag:
              description: A unique value representing the version of the chat, optionally used for optimistic concurrency control on PUT and DELETE
              schema:
                type: string
            Last-Modified:
              description: The date the chat was last updated in ISO 8601 format
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chat'
        '400':
          description: Validation issues were found
          content: {}
        '404':
          description: The chat was not found
          content: {}
        '409':
          description: A conncurrency issue occured updating the chat
          content: {}
        '412':
          description: The specified 'if-match' header was not valid, refresh and retry
          content: {}
      x-codegen-request-body-name: name
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/chats/{chatId}/channel:
    put:
      summary: Changes the channel for an existing chat
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      - name: if-match
        in: header
        description: An optional ETag for optimistic concurrency control
        required: false
        schema:
          type: string
      requestBody:
        description: Options relating to changing the channel of a the chat.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chatId_channel_body'
        required: true
      responses:
        '200':
          description: The updated chat
          headers:
            ETag:
              description: A unique value representing the version of the chat, optionally used for optimistic concurrency control on PUT and DELETE
              schema:
                type: string
            Last-Modified:
              description: The date the chat was last updated in ISO 8601 format
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chat'
        '400':
          description: Validation issues were found
          content: {}
        '404':
          description: The chat was not found
          content: {}
        '409':
          description: A conncurrency issue occured updating the chat
          content: {}
        '412':
          description: The specified 'if-match' header was not valid, refresh and retry
          content: {}
      x-codegen-request-body-name: name
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/chats/{chatId}/form:
    post:
      summary: Sends a form to a chat
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      requestBody:
        description: Options relating to sending a form to a chat.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chatId_form_body'
        required: true
      responses:
        '200':
          description: ''
          content: {}
        '400':
          description: Validation issues were found
          content: {}
        '404':
          description: The chat was not found
          content: {}
      x-codegen-request-body-name: name
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/chats:
    get:
      summary: Retrieves a list of chats
      parameters:
      - name: profileId
        in: query
        description: Indicates whether only chats the profile is a participant of should be returned
        required: false
        schema:
          type: string
      - name: scope
        in: query
        description: The scope of the query.
        required: false
        schema:
          type: string
          enum:
          - profile
          - all
          default: profile
      - name: includeClosed
        in: query
        description: Indicates whether closed chats should be returned
        required: false
        schema:
          type: boolean
      - name: includeDeleted
        in: query
        description: Indicates whether deleted chats should be returned
        required: false
        schema:
          type: boolean
      - name: idsOnly
        in: query
        description: Indicates whether just the ids should be returned
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: A list of matching chats
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Chat'
      tags:
      - Cpaas
    post:
      summary: Creates a new chat
      requestBody:
        description: Detail of the chat to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatCreate'
        required: true
      responses:
        '201':
          description: The chat was successfully created
          headers:
            ETag:
              description: A unique value representing the version of the chat, optionally used for optimistic concurrency control on PUT and DELETE
              schema:
                type: string
            Last-Modified:
              description: The date the chat was last updated in ISO 8601 format
              schema:
                type: string
                format: date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chat'
        '400':
          description: Validation issues were found
          content: {}
        '409':
          description: The chat already exists
          content: {}
      x-codegen-request-body-name: chat
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/chats/{chatId}/typing:
    post:
      summary: Indicates that the caller is typing in this chat
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The request was accepted
          content: {}
      tags:
      - Cpaas
    delete:
      summary: Indicates that the caller has stopped typing in this chat
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The request was accepted
          content: {}
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/chats/{chatId}/participants:
    get:
      summary: Retrieves the chat participants
      parameters:
      - name: chatId
        in: path
        description: The id of the chat
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested chat
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Participant'
        '404':
          description: The chat was not found
          content: {}
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/presence:
    get:
      summary: Retrieves the presence for a list of agent's profileIds
      parameters:
      - name: id
        in: query
        description: The id of a profile to retrieve presence settings for
        required: true
        schema:
          type: string
      - name: status
        in: query
        description: The current status of the profile
        required: false
        schema:
          type: string
          enum:
          - away
          - available
          - offline
      responses:
        '200':
          description: The presence for each profile requested
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Presence'
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/presence/appmessaging:
    get:
      summary: Retrieves the presence for a list of user's profileIds
      parameters:
      - name: id
        in: query
        description: The id of a profile to retrieve presence settings for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The presence for each profile requested
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppMsgPresence'
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/content:
    post:
      summary: Upload a file
      requestBody:
        description: The details and data for the file
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cpaas_content_body'
        required: true
      responses:
        '200':
          description: The file was successfully uploaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadedFile'
        '404':
          description: The file was not found
          content: {}
      x-codegen-request-body-name: File details
      tags:
      - Cpaas
    servers:
    - url: https://{region}-api.dotdigital.com
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
    - url: http://{region}-api.dotdigital.com/v2
      variables:
        region:
          description: The Dotdigital region id your account belongs to
          enum:
          - r1
          - r2
          - r3
          default: r1
  /cpaas/content/{fileId}:
    get:
      summary: Retrieve a file
      parameters:
      - name: fileId
        in: path
        description: The id of the file
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested file
          content: {}
        '404':
          description: The file was not found
          content: {}
      tags:
      - Cpaas
    delete:
      summary: Delete a file
      parameters:
      - name: fileId
        in: path
        description: The id of the file
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The file was deleted
          content: {}
        '404':
          description: The file was not found
          content: {}
      tags:
      - Cpaas
    servers:
    - url: h

# --- truncated at 32 KB (117 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dotdigital/refs/heads/main/openapi/dotdigital-cpaas-api-openapi.yml