Bright Pattern Lists API

Bright Pattern's List Management API streamlines the creation and deletion of lists and formats and provides a convenient way to manage list records. Note: Performing operations on lists requires the user to have the "Manage Lists" privilege, configured in the Contact Center Administrator application. Additional privileges required are explicitly specified in the corresponding method description. All of the methods described below use the path variable, list_id, to specify the list an operation is to be performed on. The unique identifier of a list can be found by opening that list in the Contact Center Administrator application, Lists section. The id will be displayed in the '#LISTS:LISTS_PROPERTIES:' fragment of the URL. Alternatively, list_id, can be found in the response body of the Get Lists method (see here). Methods retained from the previous version of the List management API, tagged as "DEPRECIATED", require an additional path variable, campaign_id, to reference the campaign associated with the selected list. The unique identifier of a campaign can be found by opening that campaign in the Contact Center Administrator application, Services & Campaigns section. The id will be displayed in the '#SERVICES_CAMPAIGNS:SERVICES_PROPERTIES:' fragment of the URL. Alternatively, campaign_id, can be found in the response body of the Get Campaigns method (see here). Note: When importing records or updating records it is important to remember that: All leading and trailing whitespaces should be deleted. For all PHONE numbers: If a number begins with “+”, the leading "+" sign will be removed. If a number contains non-numeric characters, they will be removed. At least one PHONE number is required. For the United States and Canada PHONE numbers: If a number begins with “011”, it will be kept as is. If a number begins with “1” and has eleven digits, it will be kept as is. If a number does not begin with “1” and has ten digits, “1” will be prepended. If a number begins with “1” and has ten digits, the record will not be imported, returning a format error. In any other case, the record will not be imported, returning a format error. Remove prefix and Default country code fields will be ignored. For Other countries PHONE numbers: If a number begins with prefix matching Remove prefix, the prefix will be deleted. If a number does not begin with prefix matching Remove prefix, it will be kept as is. If a number does not begin with prefix matching Default country code, Default country code will be added. For all INTEGER fields: If the value is presented as a string, it should be converted to an integer. Values presented as integers should be supported. For all fields that expect strings (ACCOUNT, AGENT_LOGIN_ID, FIRST_NAME, LAST_NAME, etc.) integer values should be converted to strings. Capitalization matters: values with different capitalizations are treated as distinct. For all DATE/TIME and DATE/TIME - SCHEDULE CALL AT fields: If a…

OpenAPI Specification

bright-pattern-lists-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Bright Pattern Lists API
  version: 1.0.0
  contact:
    name: Bright Pattern
    url: https://www.brightpattern.com/contact/
  description: 'Operations tagged Lists across 2 of this provider''s published API definitions: bright-pattern-list-management-v3-2-openapi.yml, bright-pattern-list-management-v3-openapi.yml. Each path carries the servers of the definition it was published in.'
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: Lists
  description: 'Bright Pattern''s List Management API streamlines the creation and deletion of lists and formats and provides a convenient way to manage list records.


    Note: Performing operations on lists requires the user to have the "Manage Lists" privilege, configured in the Contact Center Administrator application. Additional privileges required are explicitly specified in the corresponding method description.


    All of the methods described below use the path variable, list_id, to specify the list an operation is to be performed on. The unique identifier of a list can be found by opening that list in the Contact Center Administrator application, Lists section. The id will be displayed in the ''#LISTS:LISTS_PROPERTIES:'' fragment of the URL.


    Alternatively, list_id, can be found in the response body of the Get Lists method (see here).


    Methods retained from the previous version of the List management API, tagged as "DEPRECIATED", require an additional path variable, campaign_id, to reference the campaign associated with the selected list. The unique identifier of a campaign can be found by opening that campaign in the Contact Center Administrator application, Services & Campaigns section. The id will be displayed in the ''#SERVICES_CAMPAIGNS:SERVICES_PROPERTIES:'' fragment of the URL.


    Alternatively, campaign_id, can be found in the response body of the Get Campaigns method (see here).


    Note: When importing records or updating records it is important to remember that:


    All leading and trailing whitespaces should be deleted.


    For all PHONE numbers:


    If a number begins with “+”, the leading "+" sign will be removed.


    If a number contains non-numeric characters, they will be removed.


    At least one PHONE number is required.


    For the United States and Canada PHONE numbers:


    If a number begins with “011”, it will be kept as is.


    If a number begins with “1” and has eleven digits, it will be kept as is.


    If a number does not begin with “1” and has ten digits, “1” will be prepended.


    If a number begins with “1” and has ten digits, the record will not be imported, returning a format error.


    In any other case, the record will not be imported, returning a format error.


    Remove prefix and Default country code fields will be ignored.


    For Other countries PHONE numbers:


    If a number begins with prefix matching Remove prefix, the prefix will be deleted.


    If a number does not begin with prefix matching Remove prefix, it will be kept as is.


    If a number does not begin with prefix matching Default country code, Default country code will be added.


    For all INTEGER fields:


    If the value is presented as a string, it should be converted to an integer.


    Values presented as integers should be supported.


    For all fields that expect strings (ACCOUNT, AGENT_LOGIN_ID, FIRST_NAME, LAST_NAME, etc.) integer values should be converted to strings.


    Capitalization matters: values with different capitalizations are treated as distinct.


    For all DATE/TIME and DATE/TIME - SCHEDULE CALL AT fields:


    If a…'
paths:
  /configapi/v3/callinglist/getAll/{list_id}/{campaign_id}:
    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.
    post:
      operationId: getAllRecordsDeprecated
      summary: Get All Records DEPRECATED
      description: "This method returns a list of records from a calling list associated with a campaign.\n\nRecords are referenced by indexes, assigned to each record in the list in sequential order of insertion (beginning from 0). All records with an index greater than or equal to the requested record index, fromIndex, are returned in the response.\n\nNote: The returned recordset contains JSON objects sorted by the index field. List Record JSON Object has two sub-objects, entry and status, defined as follows:\n\nentry object: contains a copy of the list entry\n\nfield names are retained as defined at list creation\n\ncustom fields are returned with the prefix 'custom_' added to the name defined in the Administrator Application\n\nNote: The value returned in the id field can be used to reference this record in further API requests.\n\nstatusobject: contains the campaign results for this specific record\n\nomitted if the list is not assigned to the campaign or the campaign doesn't exist\n\nfield names are predefined\n\ncompleted field is always present, while the other fields may be absent if the record was never called or never reached an agent.\n\nInput parameters\n\nName\nType\nRequired?\nPossible/Default Values\n\nmaxSize\ninteger, ≤ 1000\nyes (Specifies the maximum number of records per page when using cursor-based pagination)\n1...1000\n\nfromIndex\nstring\nyes (specifies initial record index, used for pagination)\n-\n\nResponse Codes\n\nCode\nDescription\n\n200\nSuccess\n\n400\nBad request (format not understood; 1 or more required fields are missing or have an unsupported value)\n\n401\nAuthentication failed (invalid token format; token is expired)\n\n403\nAuthentication succeeded but the user does not have sufficient privileges\n\n404\nSpecified Campaign was not found;  \nSpecified List was not found;  \nInvalid URL"
      tags:
      - Lists
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          type: string
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              fromIndex: 0
              maxSize: '100'
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
              - entry:
                  firstname: Graham
                  phone: '16509999999'
                  id: '1'
                  lastname: Smith
                  status: Gold
                index: 0
                status:
                  globalInteractionID: 0B767156-D012-4F63-A3E2-12ACFC2F26EA
                  lastCallDuration: 0
                  lastDisposition: No disposition
                  totalAttempts: 1
                  completed: false
                  lastAgent: elizabeth
                  lastPhone: '16509999999'
                  lastDate: '2021-02-19T19:11:40.000'
              - entry:
                  firstname: Mike
                  phone: '16507777777'
                  id: '2'
                  lastname: Miller
                  status: Platinum
                index: 1
                status:
                  globalInteractionID: 3F4F2ACD-1233-42E3-8092-3A9F7D9D84BC
                  lastCallDuration: 0
                  lastDisposition: Try again later
                  totalAttempts: 1
                  completed: false
                  lastAgent: elizabeth
                  lastPhone: '16507777777'
                  lastDate: '2021-02-19T19:12:21.000'
              - entry:
                  firstname: Katrina
                  phone: '16505555555'
                  id: '3'
                  lastname: Johnson
                  status: Silver
                index: 2
                status:
                  globalInteractionID: 9D914127-C1C4-4587-8B30-4E2A9790D184
                  lastCallDuration: 0
                  lastDisposition: Product sold
                  totalAttempts: 1
                  completed: true
                  completedTime: '2021-02-19T19:12:37.000'
                  lastAgent: elizabeth
                  lastPhone: '16505555555'
                  lastDate: '2021-02-19T19:12:37.000'
              - entry:
                  firstname: Jenny
                  phone: '16502222222'
                  id: '4'
                  lastname: Green
                  status: Gold
                index: 3
                status:
                  globalInteractionID: 35DE77AC-5A37-4907-97CA-50B09B30ECDF
                  lastCallDuration: 0
                  lastDisposition: Fast busy
                  totalAttempts: 1
                  completed: false
                  lastAgent: elizabeth
                  lastPhone: '16502222222'
                  lastDate: '2021-02-19T19:13:08.000'
      security:
      - bearerAuth: []
  /configapi/v3/callinglist/getChanged/{list_id}/{campaign_id}:
    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.
    post:
      operationId: getUpdatedRecordsDeprecated
      summary: Get Updated Records DEPRECATED
      description: "This method returns a list of records from a calling list that have had any activity within the associated campaign since the requested initial time, fromTime.\n\nNote: The returned record set contains JSON objects sorted by the index field. List Record JSON Object has two sub-objects, entry and status, defined as follows:\n\nentry object: contains a copy of the list entry\n\nfield names are retained as defined at list creation\n\ncustom fields are returned with the prefix 'custom_' added to the name defined in the Administrator Application\n\ntime and date field values are returned in UTC format\n\nstatusobject: contains the campaign results for this specific record\n\nomitted if the list is not assigned to the campaign or the campaign doesn't exist\n\nfield names are predefined\n\ncompleted field is always present, while the other fields may be absent if the record was never called or never reached an agent.\n\nInput parameters\n\nName\nType\nRequired?\nPossible/Default Values\n\nmaxSize\ninteger, ≤ 1000\nyes (Specifies the maximum number of records per page when using cursor-based pagination)\n1...1000\n\nfromTime\nstring\nyes (specifies initial time)\n-\n\nResponse Codes\n\nCode\nDescription\n\n200\nSuccess\n\n400\nBad request (format not understood; 1 or more required fields are missing or have an unsupported value)\n\n401\nAuthentication failed (invalid token format; token is expired)\n\n403\nAuthentication succeeded but the user does not have sufficient privileges\n\n404\nSpecified Campaign was not found;  \nSpecified List was not found;  \nInvalid URL"
      tags:
      - Lists
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          type: string
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              fromTime: '2013-03-01T13:15:06.456'
              maxSize: '100'
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
              - entry:
                  firstname: Graham
                  phone: '16509999999'
                  id: '1'
                  lastname: Smith
                  status: Gold
                completed: false
                recordDisposition: ''
                recordDispositionCode: ''
                totalAttempts: 1
                attempts:
                - call_attempted: false
                  disposition: No disposition
                  dispositionCode: ''
                  date: '2021-02-19T19:11:40.000'
                  phone: '16509999999'
                  callDuration: 0
                  dialingDuration: 0
                  callNotes: ''
                  agent: elizabeth
                  globalInteractionID: 0B767156-D012-4F63-A3E2-12ACFC2F26EA
                  CPADuration: 0
              - entry:
                  firstname: Mike
                  phone: '16507777777'
                  id: '2'
                  lastname: Miller
                  status: Platinum
                completed: false
                recordDisposition: ''
                recordDispositionCode: ''
                totalAttempts: 1
                attempts:
                - call_attempted: false
                  disposition: Try again later
                  dispositionCode: ''
                  date: '2021-02-19T19:12:21.000'
                  phone: '16507777777'
                  callDuration: 0
                  dialingDuration: 0
                  callNotes: ''
                  agent: elizabeth
                  globalInteractionID: 3F4F2ACD-1233-42E3-8092-3A9F7D9D84BC
                  CPADuration: 0
              - entry:
                  firstname: Katrina
                  phone: '16505555555'
                  id: '3'
                  lastname: Johnson
                  status: Silver
                completed: true
                recordDisposition: Product sold
                recordDispositionCode: ''
                totalAttempts: 1
                attempts:
                - call_attempted: false
                  disposition: Product sold
                  dispositionCode: ''
                  date: '2021-02-19T19:12:37.000'
                  phone: '16505555555'
                  callDuration: 0
                  dialingDuration: 0
                  callNotes: ''
                  agent: elizabeth
                  globalInteractionID: 9D914127-C1C4-4587-8B30-4E2A9790D184
                  CPADuration: 0
              - entry:
                  firstname: Jenny
                  phone: '16502222222'
                  id: '4'
                  lastname: Green
                  status: Gold
                completed: false
                recordDisposition: ''
                recordDispositionCode: ''
                totalAttempts: 1
                attempts:
                - call_attempted: false
                  disposition: Fast busy
                  dispositionCode: ''
                  date: '2021-02-19T19:13:08.000'
                  phone: '16502222222'
                  callDuration: 0
                  dialingDuration: 0
                  callNotes: ''
                  agent: elizabeth
                  globalInteractionID: 35DE77AC-5A37-4907-97CA-50B09B30ECDF
                  CPADuration: 0
      security:
      - bearerAuth: []
  /configapi/v3/callinglist/get/{list_id}/{campaign_id}:
    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.
    post:
      operationId: queryARecordDeprecated
      summary: Query a Record DEPRECATED
      description: "This method returns a copy of an existing record in a calling list of an associated campaign. The list is specified in the path variable, list_id, by its unique identifier returned in the response body of the Get Campaign method (see here). The campaign is specified in the path variable, campaign_id, by its unique identifier returned in the response body of the Get Campaigns method (see here).\n\nThe record search is performed by its unique identifier, id, returned in the response body of the Get All Records method (see here). If the list has been added to the specified campaign more than once, the method returns an array of records. An error is returned if a record with the specified id does not exist in the selected list.\n\nNote: The response body contains the List Record JSON Object, defined by two sub-objects as follows:\n\nentry object: contains a copy of the list entry\nfield names are retained as defined at list creation\ncustom fields are returned with the prefix 'custom_' added to the name defined in the Administrator Application\n\ntime and date field values are returned in UTC format\n\nstatusobject: contains the campaign results for this specific record\nomitted if the list is not assigned to the campaign or the campaign doesn't exist\n\nfield names are predefined\n\ncompleted field is always present, while the other fields may be absent if the record was never called or never reached an agent.\n\nNote: If a PHONE type field is defined as a key, the record value is checked for a full match with the value stored in the database or the original source (if the data was modified upon loading into the database).\n\nResponse Codes\n\nCode\nDescription\n\n200\nSuccess\n\n400\nBad request (format not understood; 1 or more required fields are missing or have an unsupported value)\n\n401\nAuthentication failed (invalid token format; token is expired)\n\n403\nAuthentication succeeded but the user does not have sufficient privileges\n\n404\nSpecified List was not found;  \nSpecified Record was not found;  \nInvalid URL"
      tags:
      - Lists
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          type: string
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              id: N4
      responses:
        '200':
          description: 0 instances - 200 OK
          content:
            application/json:
              example:
                entry:
                  firstname: Mike
                  phone: '16505555555'
                  id: '2'
                  lastname: Miller
                  status: Platinum
      security:
      - bearerAuth: []
  /configapi/v3/callinglist/fetchAll/{list_id}:
    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.
    post:
      operationId: fetchAllRecords
      summary: Fetch All Records
      description: "This method returns a list of records from an existing calling list, specified in the path variable, list_id.\n\nRecords are referenced by indexes, assigned to each record in the list in sequential order of insertion (beginning from 0). All records with an index greater than or equal to the requested record index, fromIndex, are returned in the response.\n\nNote: The returned recordset contains JSON objects sorted by the index field. List Record JSON Object contains:\n\nentry object: contains a copy of the list entry\n\nfield names are retained as defined at list creation\n\nNote: This method doesn't return custom fields\n\nNote: The value returned in the id field can be used to reference this record in further API requests.\n\nInput parameters\n\nName\nType\nRequired?\nPossible/Default Values\n\nmaxSize\ninteger, ≤ 1000\nyes (Specifies the maximum number of records per page when using cursor-based pagination)\n1...1000\n\nfromIndex\nstring\nyes (specifies initial record index, used for pagination)\n-\n\nResponse Codes\n\nCode\nDescription\n\n200\nSuccess\n\n400\nBad request (format not understood; 1 or more required fields are missing or have an unsupported value)\n\n401\nAuthentication failed (invalid token format; token is expired)\n\n403\nAuthentication succeeded but the user does not have sufficient privileges\n\n404\nSpecified List was not found;  \nInvalid URL"
      tags:
      - Lists
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              fromIndex: 0
              maxSize: '100'
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example: "[\n  {\n    \"entry\": {\n      \"firstname\": \"Graham\",\n      \"phone\": \"16509999999\",\n      \"id\": \"1\",\n      \"lastname\": \"Smith\",\n      \"status\": \"Gold\"\n    },\n    \"index\": 0,\n    },\n  {\n    \"entry\": {\n      \"firstname\": \"Mike\",\n      \"phone\": \"16507777777\",\n      \"id\": \"2\",\n      \"lastname\": \"Miller\",\n      \"status\": \"Platinum\"\n    },\n    \"index\": 1,\n    },\n  {\n    \"entry\": {\n      \"firstname\": \"Katrina\",\n      \"phone\": \"16505555555\",\n      \"id\": \"3\",\n      \"lastname\": \"Johnson\",\n      \"status\": \"Silver\"\n    },\n    \"index\": 2,\n    },\n  {\n    \"entry\": {\n      \"firstname\": \"Jenny\",\n      \"phone\": \"16502222222\",\n      \"id\": \"4\",\n      \"lastname\": \"Green\",\n      \"status\": \"Gold\"\n    },\n    \"index\": 3, \n    }\n  }\n]"
      security:
      - bearerAuth: []
  /configapi/v3/callinglist/fetch/{list_id}:
    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.
    post:
      operationId: fetchRecord
      summary: Fetch Record
      description: "This method returns a copy of one or more existing records in a calling list. The search for the records is performed based on the defined key fields.\n\nNote: Time and date field values are returned in UTC format.\n\nNote: If a PHONE type field is defined as a key, the record value is checked for a full match with the value stored in the database or the original source (if the data was modified upon loading into the database).\n\nResponse Codes\n\nCode\nDescription\n\n200\nSuccess\n\n400\nBad request (format not understood; 1 or more required fields are missing or have an unsupported value)\n\n401\nAuthentication failed (invalid token format; token is expired)\n\n403\nAuthentication succeeded but the user does not have sufficient privileges\n\n404\nSpecified List was not found;  \nInvalid URL"
      tags:
      - Lists
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              phone:
              - '16505555555'
              - '16505555556'
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
                entry:
                  firstname: Mike
                  phone: '16505555555'
                  id: '2'
                  lastname: Miller
                  status: Platinum
      security:
      - bearerAuth: []
  /configapi/v3/callinglist/getAll:
    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.
    post:
      operationId: getLists
      summary: Get Lists
      description: "This method returns all Calling Lists, sorted by the standard MongoDB _id field.\n\nNote: 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.\n\nInput parameters\n\nName\nType\nRequired?\nPossible/Default Values\n\nlimit\ninteger, ≤ 1000\nyes (Specifies the maximum number of records per page when using cursor-based pagination)\n1...1000\n\ncursor\nstring\nno (used for pagination)\nFirst request: null  \nSubsequent request: value received in the response to the previous request\n\nResponse Codes\n\nCode\nDescription\n\n200\nSuccess\n\n400\nBad request (limit exceeded; format not understood; 1 or more required fields are missing or have an unsupported value)\n\n401\nAuthentication failed (invalid token format; token is expired)\n\n403\nAuthentication succeeded but the user does not have sufficient privileges\n\n404\nInvalid URL"
      tags:
      - Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              limit: 100
              cursor: 590e9abd4abbf1165862d342
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
                next_cursor: 590e9abd4abbf1165862d342
                records:
                - id: 635DB66C-AA54-41C9-9F0E-AC3A9B5EDB2D
                  name: List 1.csv
                  formatId: 31002C90-7188-11EE-A565-0800200C9A66
                  formatName: format 1
                  allowUsingDefaultTimezone: true
                  defaultTimezone: Europe/Dublin
                  totalRecords: 100
                - id: 635DB66C-AA54-41C9-9F0E-AC3A9B5EDB2D
                  name: List 2.csv
                  formatId: 31002C90-7188-11EE-A565-0800200C9A66
                  formatName: format 1
                  allowUsingDefaultTimezone: false
                  totalRecords: 100
      security:
      - bearerAuth: []
  /configapi/v3/callinglist/getList/{list_id}:
    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.
    get:
      operationId: getList
      summary: Get List
      description: "This method returns the information about a list, including its name, the format name, timezone settings, and amount of records of the specified list. Additionally, it returns the information about the associated campaign of that list, if any.\n\nResponse Codes\n\nCode\nDescription\n\n200\nSuccess\n\n400\nBad request (wrong cursor; format not understood; 1 or more required fields are missing or have an unsupported value)\n\n401\nAuthentication failed (invalid token format; token is expired)\n\n403\nAuthentication succeeded but the user does not have sufficient privileges\n\n404\nSpecified List was not found;  \nInvalid URL"
      tags:
      - Lists
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
                name: List 1.csv
                formatId: 31002C90-7188-11EE-A565-0800200C9A66
                formatName: format 1
                allowUsingDefaultTimezone: true
                defaultTimezone: Europe/Dublin
                totalRecords: 100
                campaigns:
                - campaignName: Campaign name 1
                  campaignId: 99B6B870-6CC5-11EE-807C-0800200C9A66
                  instanceId: 94D63B10-6CF1-11EE-807C-0800200C9A66
                - campaignName: Campaign name 1
                  campaignId: 99B6B870-6CC5-11EE-807C-0800200C9A66
                  instanceId: 9EA07CA0-6CF1-11EE-807C-0800200C9A66
                - campaignName: Campaign name 2
                  campaignId: 7E57DE70-6CF1-11EE-807C-0800200C9A66
                  instanceId: A5F55160-6CF1-11EE-807C-0800200C9A66
      security:
      - bearerAuth: []
  /configapi/v3/callinglist/deleteList/{list_id}:
    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.
    delete:
      operationId: deleteListAndOrphanedFormat
      summary: Delete List and Orphaned Format
      description: "This method deletes a list, archiving all records with associated campaign results associated with that list. If the last list using a specific format was deleted, that format is removed as well.\n\nNote: Bright Pattern Contact Center solution supports several voice campaign modes (see here). Depending on the mode of the associated campaign, the active call behavior will differentiate as follows:\n\nProgressive, Predictive, or Automatic (IVR) campaigns\nUpon instance deletion, all active, i.e. in a dialing state, within a script, or connected to an agent, calls are dropped\n\nPreview campaigns\nUpon instance deletion, only the calls not yet picked up by an agent are dropped. In-progress and connected calls are not affected\n\nThe results of completed calls are archived and available for downloading in the Contact Center Administrator application (see here). Interaction results for dropped calls are not saved.\n\nResponse Codes\n\nCode\nDescription\n\n200\nSuccess\n\n400\nBad request (format not understood; 1 or more required fields are missing or have an unsupported value)\n\n401\nAuthentication failed (invalid token format; token is expired)\n\n403\nAuthentication succeeded but the user does not have sufficient privileges\n\n404\nSpecified List was not found;  \nInvalid URL"
      tags:
      - Lists
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 200 OK
      security:
      - bearerAuth: []
  /configapi/v3/callinglist/createList:
    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.
    post:
      operationId: createList
      summary: Create List
      description: "This method creates a new empty list using an existing format. The format is specified by its unique identifier, formatId, returned in the response body of the Get Lists method (see here).\n\nInput parameters\n\nName\nType\nRequired?\nPossible/Default Values\n\nformatId\nstring\nyes (can be found in the Get Lists  response)\n-\n\nResponse Codes\n\nCode\nDescription\n\n200\nSuccess\n\n400\nBad request (format not understood; 1 or more required fields are missing or have an unsupported value)\n\n401\nAuthentication failed (invalid token format; token is expired)\n\n403\nAuthentication succeeded but the user does not have sufficient privileges\n\n404\nSpecified Format was not found;  \nInvalid URL\n\n409\nDuplicate name error"
      tags:
      - Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: List 3.csv
              formatId: 31002C90-7188-11EE-A565-0800200C9A66
              allowUsingDefaultTimezone: true
              defaultTimezone: Europe/Dublin
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
                id: 635DB66C-AA54-41C9-9F0E-AC3A9B5EDB2D
      security:
      - bearerAuth: []
  /configapi/v3/callinglist/createListWithNewFormat:
    servers:
    - url: https://{tenant_url}
      description: Bright Pattern is multi-tenant; the base h

# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bright-pattern/refs/heads/main/openapi/bright-pattern-lists-api-openapi.yml