Bright Pattern Link Groups API

openapi: 3.2.0
info:
  title: BPCC List Management API v3.2 Link Groups API
  version: 1.0.0
  description: 'Overview


    Bright Pattern''s List Management API supports a wide range of functionalities previously only accessible within the Contact Center Administrator application.'
  contact:
    name: Bright Pattern
    url: https://www.brightpattern.com/contact/
  x-origin:
  - format: postman
    url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
    version: '2.1'
  x-evidence:
    fetched: '2026-08-08'
    source: https://documenter.gw.postman.com/api/collections/8336025/2sB3WmV3UC?segregateAuth=true&versionTag=latest
    http_status: 200
    method: derived-from-published-postman-collection
    note: Mechanically converted from the Postman collection Bright Pattern publishes as its public API reference. No operations, paths, parameters or examples were invented.
servers:
- url: https://{tenant_url}
  description: Bright Pattern is multi-tenant; the base host is the customer contact-center tenant domain.
  variables:
    tenant_url:
      default: example.brightpattern.com
      description: Your Bright Pattern Contact Center tenant hostname.
security:
- bearerAuth: []
tags:
- name: Link Groups
  description: Bright Pattern's List Management API provides the ability to manage Link Groups so several campaigns can be linked together. When processing all records of one campaign is finished, the next campaign in the group will be started automatically. Additionally, see the Link a Campaign and Unlink a Campaign methods descriptions.
paths:
  /configapi/v3/campaignlinkgroup/getAll:
    post:
      operationId: getLinkGroups
      summary: Get Link Groups
      description: 'This method returns all Campaign Link Groups, sorted by the standard MongoDB _id field.


        Note: To accommodate the display of large numbers of list records, Bright Pattern Contact Solution utilizes Cursor-based pagination (see here). The _id field is used as the "cursor" to reference the last served record.


        Input parameters


        Name

        Type

        Required?

        Possible/Default Values


        limit

        integer, ≤ 100

        yes (specifies the maximum size of the returned list)

        1...100


        cursor

        string

        no (used for pagination)

        First request: null

        Subsequent request: value received in the response to the previous request


        Response Codes


        Code

        Description


        200

        Success


        400

        Bad request (format not understood; limit exceeded; 1 or more required fields are missing or have an unsupported value)


        401

        Authentication failed (invalid token format; token is expired)


        403

        Authentication succeeded but the user does not have sufficient privileges


        404

        Invalid URL'
      tags:
      - Link Groups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              limit: 100
              cursor: 590e9abd4abbf1165862d342
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
              - id: 6D7C2A7E-7E7A-4D43-9F6D-AB7D6F2B1F1E
                name: New
                campaignsCount: 2
      security:
      - bearerAuth: []
  /configapi/v3/campaignlinkgroup/getLinkGroup/{group_id}:
    get:
      operationId: getLinkGroup
      summary: Get Link Group
      description: 'This method returns the information about a link group, including its name and amount of linked campaigns.


        Response Codes


        Code

        Description


        200

        Success


        400

        Bad request (wrong cursor; format not understood; 1 or more required fields are missing or have an unsupported value)


        401

        Authentication failed (invalid token format; token is expired)


        403

        Authentication succeeded but the user does not have sufficient privileges


        404

        Specified Link Group was not found;

        Invalid URL'
      tags:
      - Link Groups
      parameters:
      - name: group_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
                name: New
                campaigns:
                - campaignId: 85389D39-E05C-4CE7-B36D-4401BEA52E14
                  name: Campaign 1
                  order: 0
                - campaignId: 48B91DC5-A8CD-4FCA-9AF8-EC20A4ACC14B
                  name: Campaign 2
                  order: 1
      security:
      - bearerAuth: []
  /configapi/v3/campaignlinkgroup/createLinkGroup:
    post:
      operationId: createLinkGroup
      summary: Create Link Group
      description: 'This method creates a new empty link group.


        Input parameters


        Name

        Type

        Required?

        Possible/Default Values


        name

        string

        yes

        -


        Response Codes


        Code

        Description


        200

        Success


        400

        Bad request (format not understood; 1 or more required fields are missing or have an unsupported value)


        401

        Authentication failed (invalid token format; token is expired)


        403

        Authentication succeeded but the user does not have sufficient privileges


        404

        Specified Format was not found;

        Invalid URL


        409

        Duplicate name error'
      tags:
      - Link Groups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: New
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
                id: 6D7C2A7E-7E7A-4D43-9F6D-AB7D6F2B1F1E
      security:
      - bearerAuth: []
  /configapi/v3/campaignlinkgroup/deleteLinkGroup/{group_id}:
    delete:
      operationId: deleteLinkGroup
      summary: Delete Link Group
      description: 'This method deletes an empty link group.


        Response Codes


        Code

        Description


        200

        Success


        400

        Bad request (format not understood; 1 or more required fields are missing or have an unsupported value)


        401

        Authentication failed (invalid token format; token is expired)


        403

        Authentication succeeded but the user does not have sufficient privileges


        404

        Specified Link Group was not found;

        Invalid URL


        409

        Specified Link Group is not empty'
      tags:
      - Link Groups
      parameters:
      - name: group_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 200 OK
      security:
      - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 access token issued by the Bright Pattern token endpoint, sent as `Authorization: Bearer <token>`.'
    oauth2ClientCredentials:
      type: oauth2
      description: OAuth 2.0 client-credentials grant against the Bright Pattern tenant token endpoint.
      flows:
        clientCredentials:
          tokenUrl: https://{tenant_url}/configapi/v3/oauth/token
          scopes: {}