openapi: 3.2.0
info:
  title: Infobip OpenAPI Specification Customer Engagement API
  description: OpenAPI Specification that contains all public endpoints and webhooks.
  contact:
    name: Infobip support
    email: support@infobip.com
  version: 3.210.0
  x-generatedAt: '2026-07-23T15:23:37.825639538Z'
tags:
- name: customer-engagement
  description: 'Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.

    '
  x-type: category
  x-displayName: Customer Engagement
paths:
  /people/2/persons:
    get:
      tags:
      - customer-engagement
      summary: Get a single person or a list of people
      description: Use this method with a unique person identifier to get a single person. Skip the identifier to return all people or use the `filter` parameter to return a list of people matching your specific conditions.
      operationId: get-a-single-person-or-a-list-of-people
      parameters:
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '370329180020364'
      - name: sender
        in: query
        description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2094832040560427'
      - name: type
        in: query
        description: Type of the person ID
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
        example: PHONE
      - name: limit
        in: query
        description: Number of persons to return per page. Default - 20. Maximum - 1000.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: '20'
      - name: page
        in: query
        description: Page of results to return. Default - 1.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: '1'
      - name: includeTotalCount
        in: query
        description: Returns total count of persons, if set to `true`.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: 'false'
      - name: orderBy
        in: query
        description: Results ordering. Possible ordering fields are `firstName`, `lastName`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: modifiedAt:desc
      - name: filter
        in: query
        description: 'Allows to filter persons using simple queries. Just pass to the parameter [URL encoded](https://www.w3schools.com/tags/ref_urlencode.asp) query.

          ##### List of supported logical operators:


          <table>

          <thead>

          <th>Logical Operator</th><th>Description</th>

          </thead>

          <tr>

          <td><code>#and</code></td><td>Joins query clauses with a logical AND returns all records that match the conditions of both clauses.</td>

          </tr>

          <tr>

          <td><code>#or</code></td><td>Joins query clauses with a logical OR returns all records that match the conditions of either clause.</td>

          </tr>

          </table>


          ##### List of supported comparison operators:


          <table>

          <thead>

          <th>Comparison Operator</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td><code>#eq</code></td><td>string, integer, decimal, date</td><td>Matches values that are equal to a specified value.</td>

          </tr>

          <tr>

          <td><code>#ne</code></td><td>string, integer, decimal, date</td><td>Matches all values that are not equal to a specified value.</td>

          </tr>

          <tr>

          <td><code>#contains</code></td><td>string</td><td>Matches the records that contain the specified value.</td>

          </tr>

          <tr>

          <td><code>#notContain</code></td><td>string</td><td>Matches the records that does not contain the specified value.</td>

          </tr>

          <tr>

          <td><code>#startsWith</code></td><td>string</td><td>Matches the records that start with a specified value.</td>

          </tr>

          <tr>

          <td><code>#endsWith</code></td><td>string</td><td>Matches the records that end with a specified value.</td>

          </tr>

          <tr>

          <td><code>#gt</code></td><td>integer, decimal, date</td><td>Matches values that are greater than a specified value.</td>

          </tr>

          <tr>

          <td><code>#lt</code></td><td>integer, decimal, date</td><td>Matches values that are less than a specified value.</td>

          </tr>

          <tr>

          <td><code>#gte</code></td><td>integer, decimal, date</td><td>Matches values that are greater than or equal to a specified value.</td>

          </tr>

          <tr>

          <td><code>#lte</code></td><td>integer, decimal, date</td><td>Matches values that are less than or equal to a specified value.</td>

          </tr>

          </table>

          '
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '{"#and":[{"firstName":"Alex"},{"#contains": { "tags":"VIP Client"}}]}}'
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    origin: API
                    modifiedFrom: API
                    tags:
                    - VIP Customers
                    - New Customers
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      phone:
                      - number: '41793026727'
                      email:
                      - address: janewilliams@acme.com
                      push:
                      - applicationId: FDCC8516470A3AE97FB8AC218D5D0D3D
                        registrationId: c5db0c47-465c-4e1c-abf8-7cedc275dd19
                        additionalData:
                          birthdate: '1988-07-31'
                          email: test@test.com
                          firstName: Jane
                          gender: F
                          lastName: Smith
                          middleName: Janie
                        systemData:
                          cloudType: GCM
                          registrationEnabled: 'true'
                          sdkName: MobileMessaging SDK
                          os: Android
                      facebook:
                      - applicationId: '370329180020364'
                        userId: '2094832040560427'
                        systemData:
                          gender: female
                          lastName: Smith
                          firstName: Jane
                      line:
                      - applicationId: '1644264921'
                        userId: U045147f1ad961bfe996b72bbf417f3c9
                        systemData:
                          displayName: Jane Smith
                      instagram:
                      - applicationId: '17841446795352028'
                        userId: '12461436693342628'
                        systemData:
                          displayName: jane.smith
                      twitter:
                      - applicationId: '1148203323283877'
                        userId: '370329180020364'
                        systemData:
                          displayName: Jane Smith
                      appleBusinessChat:
                      - applicationId: '387465931'
                        userId: '387465931'
                        systemData:
                          displayName: Jane Smith
                      zaloFollower:
                      - applicationId: '12345678901'
                        userId: '9876543210'
                        systemData:
                          displayName: Jane Smith
                      tiktokBm:
                      - applicationId: '7012345678901234567'
                        userId: '7123456789012345678'
                        systemData:
                          displayName: Jane Smith
                      whatsapp:
                      - applicationId: '441234567890'
                        userId: US.13491208655302741918
                        systemData:
                          username: jane.smith
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:read
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - customer-engagement
      summary: Update a person
      description: Use this method to overwrite a person profile with the data passed in the request body as follows:<br>1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute is set to empty.<br>2. Tags in the request replace the existing profile tags. If no tags are passed, the existing profile tag list is cleared.<br>3. New contact information (email addresses and phone numbers) in the request replaces the current information on the profile.
      operationId: update-a-person
      parameters:
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '370329180020364'
      - name: sender
        in: query
        description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2094832040560427'
      - name: type
        in: query
        description: Type of the person ID
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
        example: PHONE
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
            examples:
              Update person with list:
                summary: Update person with list
                value:
                  firstName: Jane
                  lastName: Smith
                  customAttributes:
                    Contract Expiry: '2018-06-01'
                    Company: Acme
                    ShoppingCartList:
                    - productName: Sneakers
                      productPrice: 25.33
                      productCategory: Sport Sneakers
                      productImage: /image1.png
                    - productName: T-Shirt
                      productPrice: 9.99
                      productCategory: Casual
                      productImage: /image2.png
                  contactInformation:
                    email:
                    - address: janewilliams@acme.com
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
            examples:
              Update person with list:
                summary: Update person with list
                value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><firstName>Jane</firstName><lastName>Smith</lastName><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><email><email><address>janewilliams@acme.com</address></email></email></contactInformation></IamPersonV2>
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    origin: API
                    modifiedFrom: API
                    tags:
                    - VIP Customers
                    - New Customers
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      phone:
                      - number: '41793026727'
                      email:
                      - address: janewilliams@acme.com
                      push:
                      - applicationId: FDCC8516470A3AE97FB8AC218D5D0D3D
                        registrationId: c5db0c47-465c-4e1c-abf8-7cedc275dd19
                        additionalData:
                          birthdate: '1988-07-31'
                          email: test@test.com
                          firstName: Jane
                          gender: F
                          lastName: Smith
                          middleName: Janie
                        systemData:
                          cloudType: GCM
                          registrationEnabled: 'true'
                          sdkName: MobileMessaging SDK
                          os: Android
                      facebook:
                      - applicationId: '370329180020364'
                        userId: '2094832040560427'
                        systemData:
                          gender: female
                          lastName: Smith
                          firstName: Jane
                      line:
                      - applicationId: '1644264921'
                        userId: U045147f1ad961bfe996b72bbf417f3c9
                        systemData:
                          displayName: Jane Smith
                      instagram:
                      - applicationId: '17841446795352028'
                        userId: '12461436693342628'
                        systemData:
                          displayName: jane.smith
                      twitter:
                      - applicationId: '1148203323283877'
                        userId: '370329180020364'
                        systemData:
                          displayName: Jane Smith
                      appleBusinessChat:
                      - applicationId: '387465931'
                        userId: '387465931'
                        systemData:
                          displayName: Jane Smith
                      zaloFollower:
                      - applicationId: '12345678901'
                        userId: '9876543210'
                        systemData:
                          displayName: Jane Smith
                      tiktokBm:
                      - applicationId: '7012345678901234567'
                        userId: '7123456789012345678'
                        systemData:
                          displayName: Jane Smith
                      whatsapp:
                      - applicationId: '441234567890'
                        userId: US.13491208655302741918
                        systemData:
                          username: jane.smith
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Create a new person
      description: Use this method to create a new person.
      operationId: create-a-new-person
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
            examples:
              Create person with list:
                summary: Create person with list
                value:
                  firstName: Jane
                  lastName: Smith
                  customAttributes:
                    Contract Expiry: '2018-06-01'
                    Company: Acme
                    ShoppingCartList:
                    - productName: Sneakers
                      productPrice: 25.33
                      productCategory: Sport Sneakers
                      productImage: /image1.png
                    - productName: T-Shirt
                      productPrice: 9.99
                      productCategory: Casual
                      productImage: /image2.png
                  contactInformation:
                    email:
                    - address: janewilliams@acme.com
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
            examples:
              Create person with list:
                summary: Create person with list
                value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><firstName>Jane</firstName><lastName>Smith</lastName><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><email><email><address>janewilliams@acme.com</address></email></email></contactInformation></IamPersonV2>
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    origin: API
                    modifiedFrom: API
                    tags:
                    - VIP Customers
                    - New Customers
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      phone:
                      - number: '41793026727'
                      email:
                      - address: janewilliams@acme.com
                      push:
                      - applicationId: FDCC8516470A3AE97FB8AC218D5D0D3D
                        registrationId: c5db0c47-465c-4e1c-abf8-7cedc275dd19
                        additionalData:
                          birthdate: '1988-07-31'
                          email: test@test.com
                          firstName: Jane
                          gender: F
                          lastName: Smith
                          middleName: Janie
                        systemData:
                          cloudType: GCM
                          registrationEnabled: 'true'
                          sdkName: MobileMessaging SDK
                          os: Android
                      facebook:
                      - applicationId: '370329180020364'
                        userId: '2094832040560427'
                        systemData:
                          gender: female
                          lastName: Smith
                          firstName: Jane
                      line:
                      - applicationId: '1644264921'
                        userId: U045147f1ad961bfe996b72bbf417f3c9
                        systemData:
                          displayName: Jane Smith
                      instagram:
                      - applicationId: '17841446795352028'
                        userId: '12461436693342628'
                        systemData:
                          displayName: jane.smith
                      twitter:
                      - applicationId: '1148203323283877'
                        userId: '370329180020364'
                        systemData:
                          displayName: Jane Smith
                      appleBusinessChat:
                      - applicationId: '387465931'
                        userId: '387465931'
                        systemData:
                          displayName: Jane Smith
                      zaloFollower:
                      - applicationId: '12345678901'
                        userId: '9876543210'
                        systemData:
                          displayName: Jane Smith
                      tiktokBm:
                      - applicationId: '7012345678901234567'
                        userId: '7123456789012345678'
                        systemData:
                          displayName: Jane Smith
                      whatsapp:
                      - applicationId: '441234567890'
                        userId: US.13491208655302741918
                        systemData:
                          username: jane.smith
                Response of create person with list:
                  summary: Response of create person with list
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    firstName: Jane
                    lastName: Smith
                    origin: API
                    modifiedFrom: API
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      email:
                      - address: janewilliams@acme.com
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>
                Response of create person with list:
                  summary: Response of create person with list
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><firstName>Jane</firstName><lastName>Smith</lastName><origin>API</origin><modifiedFrom>API</modifiedFrom><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><email><email><address>janewilliams@acme.com</address></email></email></contactInformation></IamPersonV2>
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete a person
      description: Use this method to delete a person.
      operationId: delete-a-person
      parameters:
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '370329180020364'
      - name: sender
        in: query
        description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2094832040560427'
      - name: type
        in: query
        description: Type of the person ID
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
        example: PHONE
      responses:
        '200':
          description: successful response
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Partial person update
      description: Use this method to update a person profile with the data passed in the request body as follows:<br>1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute keeps its value.<br>2. Tags in the request are appended to the profile tag list.<br>3. New contact information (email addresses and phone numbers) in the request is appended to the contact list of the profile.
      operationId: partial-person-update
      parameters:
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '370329180020364'
      - name: sender
        in: query
        description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2094832040560427'
      - name: type
        in: query
        description: Type of the person ID
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
        example: PHONE
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
            examples:
              setNewListToPerson:
                summary: Add new list to person or replace existed one
                value:
                  customAttributes:
                    ShoppingCartList:
                    - productName: Sneakers
                      productPrice: 25.33
                      productCategory: Sport Sneakers
                      productImage: /image1.png
                    - productName: T-Shirt
                      productPrice: 9.99
                      productCategory: Casual
                      productImage: /image2.png
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    origin: API
                    modifiedFrom: API
                    tags:
                    - VIP Customers
                    - New Customers
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      phone:
                      - number: '41793026727'
                      email:
                      - address: janewilliams@acme.com
                      push:
                      - applicationId: FDCC8516470A3AE97FB8AC218D5D0D3D
                        registrationId: c5db0c47-465c-4e1c-abf8-7cedc275dd19
                        additionalData:
                          birthdate: '1988-07-31'
                          email: test@test.com
                          firstName: Jane
                          gender: F
                          lastName: Smith
                          middleName: Janie
                        systemData:
                          cloudType: GCM
                          registrationEnabled: 'true'
                          sdkName: MobileMessaging SDK
                          os: Android
                      facebook:
                      - applicationId: '370329180020364'
                        userId: '2094832040560427'
                        systemData:
                          gender: female
                          lastName: Smith
                          firstName: Jane
                      line:
                      - applicationId: '1644264921'
                        userId: U045147f1ad961bfe996b72bbf417f3c9
                        systemData:
                          displayName: Jane Smith
                      instagram:
                      - applicationId: '17841446795352028'
                        userId: '12461436693342628'
                        systemData:
                          displayName: jane.smith
                      twitter:
                      - applicationId: '1148203323283877'
                        userId: '370329180020364'
                        systemData:
                          displayName: Jane Smith
                      appleBusinessChat:
                      - applicationId: '387465931'
                        userId: '387465931'
                        systemData:
                          displayName: Jane Smith
                      zaloFollower:
                      - applicationId: '12345678901'
                        userId: '9876543210'
                        systemData:
                          displayName: Jane Smith
                      tiktokBm:
                      - applicationId: '7012345678901234567'
                        userId: '7123456789012345678'
                        systemData:
                          displayName: Jane Smith
                      whatsapp:
                      - applicationId: '441234567890'
                        userId: US.13491208655302741918
                        systemData:
                          username: jane.smith
                Response of set the whole new list for person:
                  summary: Response of set the whole new list for person
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    firstName: Jane
                    lastName: Smith
                    origin: API
                    modifiedFrom: API
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      email:
                      - address: janewilliams@acme.com
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>
                Response of set the whole new list for person:
                  summary: Response of set the whole new list for person
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><firstName>Jane</firstName><lastName>Smith</lastName><origin>API</origin><modifiedFrom>API</modifiedFrom><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><email><email><address>janewilliams@acme.com</address></email></email></contactInformation></IamPersonV2>
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/persons/contactInformation:
    put:
      tags:
      - customer-engagement
      summary: Set contact information to person
      description: Use this method to replace contact information for a particular person. This methods will replace all existing emails and mobile phones with new contact information.
      operationId: set-person-contact-information
      parameters:
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '370329180020364'
      - name: sender
        in: query
        description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2094832040560427'
      - name: type
        in: query
        description: Type of the person ID
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
        example: PHONE
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest'
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    origin: API
                    modifiedFrom: API
                    tags:
                    - VIP Customers
                    - New Customers
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      phone:
                      - number: '41793026727'
                      email:
                      - address: janewilliams@acme.com
                      push:
                      - applicationId: FDCC8516470A3AE97FB8AC218D5D0D3D
                        registrationId: c5db0c47-465c-4e1c-abf8-7cedc275dd19
                        additionalData:
                          birthdate: '1988-07-31'
                          email: test@test.com
                          firstName: Jane
                          gender: F
                          lastName: Smith
                          middleName: Janie
                        systemData:
                          cloudType: GCM
                          registrationEnabled: 'true'
                          sdkName: MobileMessaging SDK
                          os: Android
                      facebook:
                      - applicationId: '370329180020364'
                        userId: '2094832040560427'
                        systemData:
                          gender: female
                          lastName: Smith
                          firstName: Jane
                      line:
                      - applicationId: '1644264921'
                        userId: U045147f1ad961bfe996b72bbf417f3c9
                        systemData:
                          displayName: Jane Smith
                      instagram:
                      - applicationId: '17841446795352028'
                        userId: '12461436693342628'
                        systemData:
                          displayName: jane.smith
                      twitter:
                      - applicationId: '1148203323283877'
                        userId: '370329180020364'
                        systemData:
                          displayName: Jane Smith
                      appleBusinessChat:
                      - applicationId: '387465931'
                        userId: '387465931'
                        systemData:
                          displayName: Jane Smith
                      zaloFollower:
                      - applicationId: '12345678901'
                        userId: '9876543210'
                        systemData:
                          displayName: Jane Smith
                      tiktokBm:
                      - applicationId: '7012345678901234567'
                        userId: '7123456789012345678'
                        systemData:
                          displayName: Jane Smith
                      whatsapp:
                      - applicationId: '441234567890'
                        userId: US.13491208655302741918
                        systemData:
                          username: jane.smith
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete contact information from person
      description: Use this method to delete specified emails and mobile phones from a particular person.
      operationId: delete-person-contact-information
      parameters:
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '370329180020364'
      - name: sender
        in: query
        description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2094832040560427'
      - name: type
        in: query
        description: Type of the person ID
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
        example: PHONE
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest'
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    origin: API
                    modifiedFrom: API
                    tags:
                    - VIP Customers
                    - New Customers
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      phone:
                      - number: '41793026727'
                      email:
                      - address: janewilliams@acme.com
                      push:
                      - applicationId: FDCC8516470A3AE97FB8AC218D5D0D3D
                        registrationId: c5db0c47-465c-4e1c-abf8-7cedc275dd19
                        additionalData:
                          birthdate: '1988-07-31'
                          email: test@test.com
                          firstName: Jane
                          gender: F
                          lastName: Smith
                          middleName: Janie
                        systemData:
                          cloudType: GCM
                          registrationEnabled: 'true'
                          sdkName: MobileMessaging SDK
                          os: Android
                      facebook:
                      - applicationId: '370329180020364'
                        userId: '2094832040560427'
                        systemData:
                          gender: female
                          lastName: Smith
                          firstName: Jane
                      line:
                      - applicationId: '1644264921'
                        userId: U045147f1ad961bfe996b72bbf417f3c9
                        systemData:
                          displayName: Jane Smith
                      instagram:
                      - applicationId: '17841446795352028'
                        userId: '12461436693342628'
                        systemData:
                          displayName: jane.smith
                      twitter:
                      - applicationId: '1148203323283877'
                        userId: '370329180020364'
                        systemData:
                          displayName: Jane Smith
                      appleBusinessChat:
                      - applicationId: '387465931'
                        userId: '387465931'
                        systemData:
                          displayName: Jane Smith
                      zaloFollower:
                      - applicationId: '12345678901'
                        userId: '9876543210'
                        systemData:
                          displayName: Jane Smith
                      tiktokBm:
                      - applicationId: '7012345678901234567'
                        userId: '7123456789012345678'
                        systemData:
                          displayName: Jane Smith
                      whatsapp:
                      - applicationId: '441234567890'
                        userId: US.13491208655302741918
                        systemData:
                          username: jane.smith
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Add contact information to person
      description: Use this method to add emails and mobile phones to a particular person.
      operationId: add-person-contact-information
      parameters:
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '370329180020364'
      - name: sender
        in: query
        description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2094832040560427'
      - name: type
        in: query
        description: Type of the person ID
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
        example: PHONE
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest'
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    origin: API
                    modifiedFrom: API
                    tags:
                    - VIP Customers
                    - New Customers
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      phone:
                      - number: '41793026727'
                      email:
                      - address: janewilliams@acme.com
                      push:
                      - applicationId: FDCC8516470A3AE97FB8AC218D5D0D3D
                        registrationId: c5db0c47-465c-4e1c-abf8-7cedc275dd19
                        additionalData:
                          birthdate: '1988-07-31'
                          email: test@test.com
                          firstName: Jane
                          gender: F
                          lastName: Smith
                          middleName: Janie
                        systemData:
                          cloudType: GCM
                          registrationEnabled: 'true'
                          sdkName: MobileMessaging SDK
                          os: Android
                      facebook:
                      - applicationId: '370329180020364'
                        userId: '2094832040560427'
                        systemData:
                          gender: female
                          lastName: Smith
                          firstName: Jane
                      line:
                      - applicationId: '1644264921'
                        userId: U045147f1ad961bfe996b72bbf417f3c9
                        systemData:
                          displayName: Jane Smith
                      instagram:
                      - applicationId: '17841446795352028'
                        userId: '12461436693342628'
                        systemData:
                          displayName: jane.smith
                      twitter:
                      - applicationId: '1148203323283877'
                        userId: '370329180020364'
                        systemData:
                          displayName: Jane Smith
                      appleBusinessChat:
                      - applicationId: '387465931'
                        userId: '387465931'
                        systemData:
                          displayName: Jane Smith
                      zaloFollower:
                      - applicationId: '12345678901'
                        userId: '9876543210'
                        systemData:
                          displayName: Jane Smith
                      tiktokBm:
                      - applicationId: '7012345678901234567'
                        userId: '7123456789012345678'
                        systemData:
                          displayName: Jane Smith
                      whatsapp:
                      - applicationId: '441234567890'
                        userId: US.13491208655302741918
                        systemData:
                          username: jane.smith
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/persons/batch:
    post:
      tags:
      - customer-engagement
      summary: Batch people create
      description: Use this method to create multiple persons.<br>**NOTE** Array size of the batch create request is limited to `1000` persons.
      operationId: batch-people-create
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateRequest'
            examples:
              Batch people create:
                summary: Batch people create
                value:
                  people:
                  - firstName: Jane
                    lastName: Smith
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      email:
                      - address: janewilliams@acme.com
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateRequest'
            examples:
              Batch people create:
                summary: Batch people create
                value: <?xml version='1.0' encoding='UTF-8'?><BatchCreateRequest><people><people><firstName>Jane</firstName><lastName>Smith</lastName><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><email><email><address>janewilliams@acme.com</address></email></email></contactInformation></people></people></BatchCreateRequest>
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse'
              examples:
                Batch people create:
                  summary: Batch people create
                  value:
                    results:
                    - errors:
                      - message: Destination(email) janewilliams@acme.com already exists.
                      status: 409
                      index: 0
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse'
              examples:
                Batch people create:
                  summary: Batch people create
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchCreateResponse>\n  <results>\n    <results>\n      <errors>\n        <errors>\n          <message>Destination(email) janewilliams@acme.com already exists.</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <index>0</index>\n    </results>\n  </results>\n</BatchCreateResponse>\n"
        '207':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse'
              examples:
                Batch people create:
                  summary: Batch people create
                  value:
                    results:
                    - errors:
                      - message: Destination(email) janewilliams@acme.com already exists.
                      status: 409
                      index: 0
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse'
              examples:
                Batch people create:
                  summary: Batch people create
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchCreateResponse>\n  <results>\n    <results>\n      <errors>\n        <errors>\n          <message>Destination(email) janewilliams@acme.com already exists.</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <index>0</index>\n    </results>\n  </results>\n</BatchCreateResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Batch people delete
      description: Use this method to delete multiple persons.<br>**NOTE** Array size of the batch delete request is limited to `1000` persons.
      operationId: batch-people-delete
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteRequest'
            examples:
              Batch people delete:
                summary: Batch people delete
                value:
                  people:
                  - query:
                      type: PHONE
                      identifier: '41793026727'
                  - query:
                      type: EMAIL
                      identifier: johnwilliams@acme.com
                  - query:
                      type: EXTERNAL_ID
                      identifier: '123'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteRequest'
            examples:
              Batch people delete:
                summary: Batch people delete
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchDeleteRequest>\n  <people>\n    <people>\n      <query>\n        <type>PHONE</type>\n        <identifier>41793026727</identifier>\n      </query>\n    </people>\n    <people>\n      <query>\n        <type>EMAIL</type>\n        <identifier>johnwilliams@acme.com</identifier>\n      </query>\n    </people>\n    <people>\n      <query>\n        <type>EXTERNAL_ID</type>\n        <identifier>123</identifier>\n      </query>\n    </people>\n  </people>\n</BatchDeleteRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse'
              examples:
                Batch people delete:
                  summary: Batch people delete
                  value:
                    results:
                    - errors:
                      - message: There is no person matching the query
                      status: 409
                      query:
                        type: PHONE
                        identifier: '41793026727'
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse'
              examples:
                Batch people delete:
                  summary: Batch people delete
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchDeleteResponse>\n  <results>\n    <results>\n      <errors>\n        <errors>\n          <message>There is no person matching the query</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <query>\n        <type>PHONE</type>\n        <identifier>41793026727</identifier>\n      </query>\n    </results>\n  </results>\n</BatchDeleteResponse>\n"
        '207':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse'
              examples:
                Batch people delete:
                  summary: Batch people delete
                  value:
                    results:
                    - errors:
                      - message: There is no person matching the query
                      status: 409
                      query:
                        type: PHONE
                        identifier: '41793026727'
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse'
              examples:
                Batch people delete:
                  summary: Batch people delete
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchDeleteResponse>\n  <results>\n    <results>\n      <errors>\n        <errors>\n          <message>There is no person matching the query</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <query>\n        <type>PHONE</type>\n        <identifier>41793026727</identifier>\n      </query>\n    </results>\n  </results>\n</BatchDeleteResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Batch people update
      description: Use this method to update multiple person profiles with the data passed in the request body as follows:<br>1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute keeps its value.<br>2. Tags in the request are appended to the profile tag list.<br>3. New contact information (email addresses and phone numbers) in the request is appended to the contact list of the profile.<br>**NOTE** Array size of the batch update request is limited to `1000` persons.
      operationId: batch-people-update
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  people:
                    type: array
                    description: List of people.
                    items:
                      type: object
                      properties:
                        query:
                          allOf:
                          - $ref: '#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery'
                        update:
                          allOf:
                          - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
                title: Batch people update
            examples:
              batchPeopleUpdate:
                summary: batchPeopleUpdate
                value:
                  people:
                  - query:
                      identifier: dab3a9cf-e8d0-42cf-9b2b-4745a8fff
                      type: EXTERNAL_ID
                    update:
                      firstName: Jack
                      lastName: Smith
                      customAttributes:
                        displayName: jacky
                      contactInformation:
                        phone:
                        - number: '44598123467'
                  - query:
                      identifier: '41793026727'
                      type: PHONE
                    update:
                      firstName: Jane
                      lastName: Smith
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse'
              examples:
                Batch people update:
                  summary: Batch people update
                  value:
                    results:
                    - errors:
                      - message: There is no person matching the query
                      status: 409
                      query:
                        type: PHONE
                        identifier: '41793026727'
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse'
              examples:
                Batch people update:
                  summary: Batch people update
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchUpdateResponse>\n  <results>\n    <results>\n      <errors>\n        <errors>\n          <message>There is no person matching the query</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <query>\n        <type>PHONE</type>\n        <identifier>41793026727</identifier>\n      </query>\n    </results>\n  </results>\n</BatchUpdateResponse>\n"
        '207':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse'
              examples:
                Batch people update:
                  summary: Batch people update
                  value:
                    results:
                    - errors:
                      - message: There is no person matching the query
                      status: 409
                      query:
                        type: PHONE
                        identifier: '41793026727'
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse'
              examples:
                Batch people update:
                  summary: Batch people update
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchUpdateResponse>\n  <results>\n    <results>\n      <errors>\n        <errors>\n          <message>There is no person matching the query</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <query>\n        <type>PHONE</type>\n        <identifier>41793026727</identifier>\n      </query>\n    </results>\n  </results>\n</BatchUpdateResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/persons/match:
    post:
      tags:
      - customer-engagement
      summary: Match profiles
      description: Use this method to match a list of identities against existing person profiles in People. For each successfully matched identity the internal ID of the person profile will be returned.  Duplicate identities will fetch a single profile reference.
      operationId: match-people-ids
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  identities:
                  - type: EXTERNAL_ID
                    identifier: XXX
                  - type: PHONE
                    identifier: XXXXXXXXXXX
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    matches:
                    - type: EMAIL
                      identifier: example@example.com
                      personId: 1
                    - type: PUSH
                      identifier: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                      sender: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                      personId: 2
        '400':
          description: Bad request
          content:
            application/json: {}
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                type: object
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:read
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 15
        numberOfTimeUnits: 0
        timeUnit: s
  /people/3/persons/merge:
    post:
      tags:
      - customer-engagement
      summary: Batch merge profiles
      description: 'Use this method to merge multiple person profiles belonging to the same user based on matching identifiers such as external ID, email, phone, and other contact information. The standard merge logic applies: the system selects a primary profile and consolidates fields and events from the secondary profiles into it. More information about the merge logic is available in the [People documentation](https://www.infobip.com/docs/people/synchronize-your-audience#merge-duplicate). <br>Any data included in the merge request overrides what is already stored. If the request provides a new external ID or new contact information, it is written into the resulting profile, either replacing the existing identifier or being added to the contact list, depending on the type. <br>If the merge request includes only new identifiers or contact information that match no existing profile, the system creates a new profile and populates it entirely with the data from the request. <br>**Notes:** <br>1. The batch size limit is 1000 persons. <br>2. Contact information in the request is checked only for formal validity (emails and phone numbers). Ensure its correctness, alignment with configured senders, and absence of errors.'
      operationId: merge-persons
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeRequestDocsSchema'
            examples:
              valid request - single person:
                summary: valid request - single person
                description: valid request - single person
                value:
                  persons:
                  - externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                    - identifier: john.doe@example.com
                      type: EMAIL
                    - identifier: '41793026727'
                      type: PHONE
                    tags:
                    - VIP Customers
                    - New Customers
              valid request - multiple persons:
                summary: valid request - multiple persons
                description: valid request - multiple persons
                value:
                  persons:
                  - externalId: '3'
                    firstName: Jane
                  - externalId: '4'
                    city: Paris
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example.com
                      type: EMAIL
              Mixed valid and invalid request:
                summary: Mixed valid and invalid request
                description: Mixed valid and invalid request
                value:
                  persons:
                  - externalId: '3'
                    firstName: Jane
                  - firstName: Joe
                    contactInformation:
                    - identifier: '000'
                      type: PHONE
                  - externalId: '4'
                    city: Paris
              all invalid request:
                summary: all invalid request
                description: all invalid request
                value:
                  persons:
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example.com
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example
                      type: EMAIL
        required: true
      responses:
        '207':
          description: Multi-Status - Batch operation completed with individual results
          content:
            application/json:
              schema:
                type: object
                description: Batch response for upsert operations
                properties:
                  errors:
                    $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorResponseV3'
                  results:
                    $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeSuccessResult'
              examples:
                Successful merge - Single person:
                  summary: Successful merge - Single person
                  description: Single person successfully merged
                  value:
                    errors: []
                    results:
                    - id: 12345
                      index: 0
                Successful merge - Multiple persons:
                  summary: Successful merge - Multiple persons
                  description: Multiple persons successfully merged
                  value:
                    errors: []
                    results:
                    - id: 12345
                      index: 0
                    - id: 12346
                      index: 1
                    - id: 12347
                      index: 2
                mixed success and validation errors:
                  summary: mixed success and validation errors
                  description: Some persons merged successfully, others failed validation
                  value:
                    errors:
                    - code: 400100
                      message: One or more properties of the person are invalid
                      details:
                      - property: persons[1].contactInformation[0].identifier
                        message: Phone number is invalid
                      index: 1
                    results:
                    - id: 12345
                      index: 0
                    - id: 12347
                      index: 2
                all validation errors:
                  summary: all validation errors
                  description: All persons in the batch failed validation
                  value:
                    errors:
                    - code: 400100
                      message: One or more properties of the person are invalid
                      details:
                      - property: persons[0].contactInformation[0].type
                        message: Must not be null
                      index: 0
                    - code: 400100
                      message: One or more properties of the person are invalid
                      details:
                      - property: persons[1].contactInformation[0].identifier
                        message: Email address is invalid
                      index: 1
                    results: []
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                malformed JSON:
                  summary: malformed JSON
                  description: malformed JSON
                  value:
                    code: 400103
                    message: Malformed JSON body, wrong syntax
                missing required property:
                  summary: missing required property
                  description: missing required property
                  value:
                    code: 400104
                    message: Missing required property 'persons'
                    details:
                    - property: persons
                      message: Required, but value is missing
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:read
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/3/persons/upsert:
    put:
      tags:
      - customer-engagement
      summary: Batch full people upsert
      description: 'Use this method to create or fully replace person profiles by matching on identifiers such as external ID, email, or phone. If a match is identified, the existing profile is entirely replaced with the provided data; any fields excluded from the request will be cleared. If no match is identified, a new profile is created. The operation returns a status for each profile: CREATED, UPDATED, or NOT_MODIFIED.<br>**Notes:** <br>1. The batch size limit is 1000 persons. <br>2. Contact information (emails and phone numbers) in the request is checked only for formal validity. Ensure accuracy and absence of errors.'
      operationId: upsert-persons-full
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertRequestDocsSchema'
            examples:
              valid request - single person:
                summary: valid request - single person
                description: valid request - single person
                value:
                  persons:
                  - externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                    - identifier: john.doe@example.com
                      type: EMAIL
                    - identifier: '41793026727'
                      type: PHONE
                    tags:
                    - VIP Customers
                    - New Customers
              valid request - multiple persons:
                summary: valid request - multiple persons
                description: valid request - multiple persons
                value:
                  persons:
                  - externalId: '3'
                    firstName: Jane
                  - externalId: '4'
                    city: Paris
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example.com
                      type: EMAIL
              mixed valid and invalid request:
                summary: mixed valid and invalid request
                description: mixed valid and invalid request
                value:
                  persons:
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example
                      type: EMAIL
                  - externalId: '4'
                    city: Paris
              all invalid request:
                summary: all invalid request
                description: all invalid request
                value:
                  persons:
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example
                      type: EMAIL
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example
        required: true
      responses:
        '207':
          description: Multi-Status - Batch operation completed with individual results
          content:
            application/json:
              schema:
                type: object
                description: Batch response for upsert operations
                properties:
                  errors:
                    $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorResponseV3'
                  results:
                    $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertSuccessResult'
              examples:
                Successful upsert - Single person created:
                  summary: Successful upsert - Single person created
                  description: Single person successfully created
                  value:
                    errors: []
                    results:
                    - id: 12345
                      index: 0
                      status: CREATED
                Successful upsert - Multiple persons with different statuses:
                  summary: Successful upsert - Multiple persons with different statuses
                  description: Multiple persons processed with different operation results
                  value:
                    errors: []
                    results:
                    - id: 1
                      index: 0
                      status: NOT_MODIFIED
                    - id: 2
                      index: 1
                      status: UPDATED
                    - id: 3
                      index: 2
                      status: CREATED
                Mixed success and validation errors:
                  summary: Mixed success and validation errors
                  description: Some persons processed successfully, others failed validation
                  value:
                    errors:
                    - code: 400100
                      message: One or more properties of the person are invalid
                      details:
                      - property: persons[0].contactInformation[0].identifier
                        message: Email address is invalid
                      index: 0
                    results:
                    - id: 2
                      index: 1
                      status: NOT_MODIFIED
                All validation errors:
                  summary: All validation errors
                  description: All persons in the batch failed validation
                  value:
                    errors:
                    - code: 400100
                      message: One or more properties of the person are invalid
                      details:
                      - property: persons[0].contactInformation[0].identifier
                        message: Email address is invalid
                      index: 0
                    - code: 400100
                      message: One or more properties of the person are invalid
                      details:
                      - property: persons[1].contactInformation[0].type
                        message: Must not be null
                      index: 1
                    results: []
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                malformed JSON:
                  summary: malformed JSON
                  description: malformed JSON
                  value:
                    code: 400103
                    message: Malformed JSON body, wrong syntax
                missing required property:
                  summary: missing required property
                  description: missing required property
                  value:
                    code: 400104
                    message: Missing required property 'persons'
                    details:
                    - property: persons
                      message: Required, but value is missing
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:read
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Batch partial people upsert
      description: 'Use this method to create or partially update person profiles by matching on identifiers such as external ID, email, or phone. If a match is identified, the existing profile is updated only with the provided data; any fields excluded from the request remain unchanged. If no match is identified, a new profile is created. The operation returns a status for each profile: CREATED, UPDATED, or NOT_MODIFIED. <br>**Notes:** <br>1. The batch size limit is 1000 persons. <br>2. Contact information (emails and phone numbers) in the request is checked only for formal validity. Ensure accuracy and absence of errors.'
      operationId: upsert-persons-partial
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertRequestDocsSchema'
            examples:
              valid request - single person:
                summary: valid request - single person
                description: valid request - single person
                value:
                  persons:
                  - externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                    - identifier: john.doe@example.com
                      type: EMAIL
                    - identifier: '41793026727'
                      type: PHONE
                    tags:
                    - VIP Customers
                    - New Customers
              valid request - multiple persons:
                summary: valid request - multiple persons
                description: valid request - multiple persons
                value:
                  persons:
                  - externalId: '3'
                    firstName: Jane
                  - externalId: '4'
                    city: Paris
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example.com
                      type: EMAIL
              mixed valid and invalid request:
                summary: mixed valid and invalid request
                description: mixed valid and invalid request
                value:
                  persons:
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example
                      type: EMAIL
                  - externalId: '4'
                    city: Paris
              all invalid request:
                summary: all invalid request
                description: all invalid request
                value:
                  persons:
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example
                      type: EMAIL
                  - firstName: Joe
                    contactInformation:
                    - identifier: john.doe@example
        required: true
      responses:
        '207':
          description: Multi-Status - Batch operation completed with individual results
          content:
            application/json:
              schema:
                type: object
                description: Batch response for upsert operations
                properties:
                  errors:
                    $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorResponseV3'
                  results:
                    $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertSuccessResult'
              examples:
                Successful upsert - Single person created:
                  summary: Successful upsert - Single person created
                  description: Single person successfully created
                  value:
                    errors: []
                    results:
                    - id: 12345
                      index: 0
                      status: CREATED
                Successful upsert - Multiple persons with different statuses:
                  summary: Successful upsert - Multiple persons with different statuses
                  description: Multiple persons processed with different operation results
                  value:
                    errors: []
                    results:
                    - id: 1
                      index: 0
                      status: NOT_MODIFIED
                    - id: 2
                      index: 1
                      status: UPDATED
                    - id: 3
                      index: 2
                      status: CREATED
                Mixed success and validation errors:
                  summary: Mixed success and validation errors
                  description: Some persons processed successfully, others failed validation
                  value:
                    errors:
                    - code: 400100
                      message: One or more properties of the person are invalid
                      details:
                      - property: persons[0].contactInformation[0].identifier
                        message: Email address is invalid
                      index: 0
                    results:
                    - id: 2
                      index: 1
                      status: NOT_MODIFIED
                All validation errors:
                  summary: All validation errors
                  description: All persons in the batch failed validation
                  value:
                    errors:
                    - code: 400100
                      message: One or more properties of the person are invalid
                      details:
                      - property: persons[0].contactInformation[0].identifier
                        message: Email address is invalid
                      index: 0
                    - code: 400100
                      message: One or more properties of the person are invalid
                      details:
                      - property: persons[1].contactInformation[0].type
                        message: Must not be null
                      index: 1
                    results: []
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                malformed JSON:
                  summary: malformed JSON
                  description: malformed JSON
                  value:
                    code: 400103
                    message: Malformed JSON body, wrong syntax
                missing required property:
                  summary: missing required property
                  description: missing required property
                  value:
                    code: 400104
                    message: Missing required property 'persons'
                    details:
                    - property: persons
                      message: Required, but value is missing
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:read
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/companies:
    get:
      tags:
      - customer-engagement
      summary: Get a single company or a list of companies
      description: Use this method with a query parameter to get a single company. If the query parameter is not specified, this method will return a list of companies.
      operationId: get-a-single-company-by-name-or-a-list-of-companies
      parameters:
      - name: name
        in: query
        description: Name of company you want to get.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Infobip
      - name: id
        in: query
        description: ID of company you want to get.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
        example: '11351351'
      - name: externalId
        in: query
        description: External ID of company you want to get.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '11351351'
      - name: domain
        in: query
        description: Domain of company you want to get.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: www.infobip.com
      - name: limit
        in: query
        description: Number of companies to return per page. Default - 20. Maximum - 1000.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: '20'
      - name: page
        in: query
        description: Page of results to return. Default - 1.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: '1'
      - name: includeTotalCount
        in: query
        description: Returns total count of companies, if set to `true`.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: 'false'
      - name: orderBy
        in: query
        description: Results ordering. Possible ordering fields are `name`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: modifiedAt:desc
      - name: filter
        in: query
        description: 'Allows to filter companies using simple queries. Just pass to the parameter [URL encoded](https://www.w3schools.com/tags/ref_urlencode.asp) query.

          ##### List of supported logical operators:


          <table>

          <thead>

          <th>Logical Operator</th><th>Description</th>

          </thead>

          <tr>

          <td><code>#and</code></td><td>Joins query clauses with a logical AND returns all records that match the conditions of both clauses.</td>

          </tr>

          <tr>

          <td><code>#or</code></td><td>Joins query clauses with a logical OR returns all records that match the conditions of either clause.</td>

          </tr>

          </table>


          ##### List of supported comparison operators:


          <table>

          <thead>

          <th>Comparison Operator</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td><code>#eq</code></td><td>string, integer, decimal, date</td><td>Matches values that are equal to a specified value.</td>

          </tr>

          <tr>

          <td><code>#ne</code></td><td>string, integer, decimal, date</td><td>Matches all values that are not equal to a specified value.</td>

          </tr>

          <tr>

          <td><code>#contains</code></td><td>string</td><td>Matches the records that contain a specified value.</td>

          </tr>

          <tr>

          <td><code>#startsWith</code></td><td>string</td><td>Matches the records that start with a specified value.</td>

          </tr>

          <tr>

          <td><code>#endsWith</code></td><td>string</td><td>Matches the records that end with a specified value.</td>

          </tr>

          <tr>

          <td><code>#gt</code></td><td>integer, decimal, date</td><td>Matches values that are greater than a specified value.</td>

          </tr>

          <tr>

          <td><code>#lt</code></td><td>integer, decimal, date</td><td>Matches values that are less than a specified value.</td>

          </tr>

          <tr>

          <td><code>#gte</code></td><td>integer, decimal, date</td><td>Matches values that are greater than or equal to a specified value.</td>

          </tr>

          <tr>

          <td><code>#lte</code></td><td>integer, decimal, date</td><td>Matches values that are less than or equal to a specified value.</td>

          </tr>

          </table>

          '
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '{"#or":[{"name":"infobip"},{"#contains":{"notes":"another"}}]}'
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.CompaniesResponse'
              examples:
                Get single company response:
                  summary: Get single company response
                  value:
                    companies:
                    - createdAt: '2017-12-01T19:16:41'
                      modifiedAt: '2017-12-01T19:16:41'
                      id: 1
                      name: Infobip
                      notes: notes example
                      country: Croatia
                      region: Europe
                      accountManager: Jane Smith
                      customerStage: Active
                      industry: IT
                      vatNumber: 003212059
                      customAttributes:
                        Contract Expiry: '2018-06-01'
                      domains:
                      - infobip.com
                      tags:
                      - Vip
                      origin: API
                      modifiedFrom: API
                Get companies response:
                  summary: Get companies response
                  value:
                    companies:
                    - createdAt: '2017-12-01T19:16:41'
                      modifiedAt: '2017-12-01T19:16:41'
                      id: 1
                      name: Infobip
                      notes: notes example
                      country: Croatia
                      region: Europe
                      accountManager: Jane Smith
                      customerStage: Active
                      industry: IT
                      vatNumber: 003212059
                      customAttributes:
                        Contract Expiry: '2018-06-01'
                      domains:
                      - infobip.com
                      tags:
                      - Vip
                      origin: API
                      modifiedFrom: API
                    - createdAt: '2018-12-01T19:16:41'
                      modifiedAt: '2018-12-01T19:16:41'
                      id: 2
                      name: Google
                      notes: notes example
                      country: UK
                      region: Europe
                      accountManager: Jack Smith
                      customerStage: Active
                      industry: IT
                      vatNumber: '003212060'
                      customAttributes:
                        Contract Expiry: '2019-06-01'
                      domains:
                      - google-uk.com
                      tags:
                      - Vip
                      origin: API
                      modifiedFrom: API
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.CompaniesResponse'
              examples:
                Get single company response:
                  summary: Get single company response
                  value: <?xml version='1.0' encoding='UTF-8'?><CompaniesResponse><companies><companies><createdAt>2017-12-01T19:16:41</createdAt><modifiedAt>2017-12-01T19:16:41</modifiedAt><id>1</id><name>Infobip</name><notes>notes example</notes><country>Croatia</country><region>Europe</region><accountManager>Jane Smith</accountManager><customerStage>Active</customerStage><industry>IT</industry><vatNumber>003212059</vatNumber><customAttributes><Contract Expiry>2018-06-01</Contract Expiry></customAttributes><domains><domains>infobip.com</domains></domains><tags><tags>Vip</tags></tags><origin>API</origin><modifiedFrom>API</modifiedFrom></companies></companies></CompaniesResponse>
                Get companies response:
                  summary: Get companies response
                  value: <?xml version='1.0' encoding='UTF-8'?><CompaniesResponse><companies><companies><createdAt>2017-12-01T19:16:41</createdAt><modifiedAt>2017-12-01T19:16:41</modifiedAt><id>1</id><name>Infobip</name><notes>notes example</notes><country>Croatia</country><region>Europe</region><accountManager>Jane Smith</accountManager><customerStage>Active</customerStage><industry>IT</industry><vatNumber>003212059</vatNumber><customAttributes><Contract Expiry>2018-06-01</Contract Expiry></customAttributes><domains><domains>infobip.com</domains></domains><tags><tags>Vip</tags></tags><origin>API</origin><modifiedFrom>API</modifiedFrom></companies><companies><createdAt>2018-12-01T19:16:41</createdAt><modifiedAt>2018-12-01T19:16:41</modifiedAt><id>2</id><name>Google</name><notes>notes example</notes><country>UK</country><region>Europe</region><accountManager>Jack Smith</accountManager><customerStage>Active</customerStage><industry>IT</industry><vatNumber>003212060</vatNumber><customAttributes><Contract Expiry>2019-06-01</Contract Expiry></customAttributes><domains><domains>google-uk.com</domains></domains><tags><tags>Vip</tags></tags><origin>API</origin><modifiedFrom>API</modifiedFrom></companies></companies></CompaniesResponse>
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-is-early-access: true
      x-scopes:
      - people:manage
      - people:read
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Create a new company
      description: Use this method to create a new company.
      operationId: create-company
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2'
            examples:
              Create company:
                summary: Create company
                value:
                  name: Infobip
                  notes: notes example
                  country: Croatia
                  region: Europe
                  accountManager: Jane Smith
                  customerStage: Active
                  industry: IT
                  vatNumber: 003212059
                  customAttributes:
                    Contract Expiry: '2018-06-01'
                  domains:
                  - infobip.com
                  tags:
                  - Vip
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2'
            examples:
              Create company:
                summary: Create company
                value: <?xml version='1.0' encoding='UTF-8'?><IamCompanyV2><name>Infobip</name><notes>notes example</notes><country>Croatia</country><region>Europe</region><accountManager>Jane Smith</accountManager><customerStage>Active</customerStage><industry>IT</industry><vatNumber>003212059</vatNumber><customAttributes><Contract Expiry>2018-06-01</Contract Expiry></customAttributes><domains><domains>infobip.com</domains></domains><tags><tags>Vip</tags></tags></IamCompanyV2>
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2'
              examples:
                Company response:
                  summary: Company response
                  value:
                    createdAt: '2017-12-01T19:16:41'
                    modifiedAt: '2017-12-01T19:16:41'
                    id: 1
                    name: Infobip
                    notes: notes example
                    country: Croatia
                    region: Europe
                    accountManager: Jane Smith
                    customerStage: Active
                    industry: IT
                    vatNumber: 003212059
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                    domains:
                    - infobip.com
                    tags:
                    - Vip
                    origin: API
                    modifiedFrom: API
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2'
              examples:
                Company response:
                  summary: Company response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamCompanyV2><createdAt>2017-12-01T19:16:41</createdAt><modifiedAt>2017-12-01T19:16:41</modifiedAt><id>1</id><name>Infobip</name><notes>notes example</notes><country>Croatia</country><region>Europe</region><accountManager>Jane Smith</accountManager><customerStage>Active</customerStage><industry>IT</industry><vatNumber>003212059</vatNumber><customAttributes><Contract Expiry>2018-06-01</Contract Expiry></customAttributes><domains><domains>infobip.com</domains></domains><tags><tags>Vip</tags></tags><origin>API</origin><modifiedFrom>API</modifiedFrom></IamCompanyV2>
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-is-early-access: true
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete a company
      description: Use this method with a query parameter to delete a company. Exactly one of the query parameters must be included in the query.
      operationId: delete-company
      parameters:
      - name: id
        in: query
        description: ID of company you want to delete.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
        example: '11351351'
      - name: externalId
        in: query
        description: External ID of company you want to delete.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '11351351'
      - name: name
        in: query
        description: Name of company you want to delete.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Infobip
      - name: domain
        in: query
        description: Domain of company you want to delete.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: company-domain.com
      responses:
        '200':
          description: successful response
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-is-early-access: true
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Partial company update
      description: Partial company update method is used for updating a part of the company information. Exactly one of the query parameters must be included in the query.
      operationId: update-company
      parameters:
      - name: id
        in: query
        description: ID of company you want to update.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
        example: '11351351'
      - name: externalId
        in: query
        description: External ID of company you want to update.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '11351351'
      - name: name
        in: query
        description: Name of company you want to update.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Infobip
      - name: domain
        in: query
        description: Domain of company you want to update.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: company-domain.com
      - name: replaceTags
        in: query
        description: Flag which indicates tag replacement operation.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: 'false'
      - name: replaceDomains
        in: query
        description: Flag which indicates domain replacement operation.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: 'false'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2'
            examples:
              setNewCustomerStageRequest:
                summary: Set the new customerStage for company
                value:
                  customerStage: Testing
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2'
              examples:
                Company response:
                  summary: Company response
                  value:
                    createdAt: '2017-12-01T19:16:41'
                    modifiedAt: '2017-12-01T19:16:41'
                    id: 1
                    name: Infobip
                    notes: notes example
                    country: Croatia
                    region: Europe
                    accountManager: Jane Smith
                    customerStage: Active
                    industry: IT
                    vatNumber: 003212059
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                    domains:
                    - infobip.com
                    tags:
                    - Vip
                    origin: API
                    modifiedFrom: API
                Response of set the new customerStage for company:
                  summary: Response of set the new customerStage for company
                  value:
                    createdAt: '2017-12-01T19:16:41'
                    modifiedAt: '2017-12-01T19:16:41'
                    id: 1
                    name: Infobip
                    notes: notes example
                    country: Croatia
                    region: Europe
                    accountManager: Jane Smith
                    customerStage: Testing
                    industry: IT
                    vatNumber: 003212059
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                    domains:
                    - infobip.com
                    tags:
                    - Vip
                    origin: API
                    modifiedFrom: API
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2'
              examples:
                Company response:
                  summary: Company response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamCompanyV2><createdAt>2017-12-01T19:16:41</createdAt><modifiedAt>2017-12-01T19:16:41</modifiedAt><id>1</id><name>Infobip</name><notes>notes example</notes><country>Croatia</country><region>Europe</region><accountManager>Jane Smith</accountManager><customerStage>Active</customerStage><industry>IT</industry><vatNumber>003212059</vatNumber><customAttributes><Contract Expiry>2018-06-01</Contract Expiry></customAttributes><domains><domains>infobip.com</domains></domains><tags><tags>Vip</tags></tags><origin>API</origin><modifiedFrom>API</modifiedFrom></IamCompanyV2>
                Response of set the new customerStage for company:
                  summary: Response of set the new customerStage for company
                  value: <?xml version='1.0' encoding='UTF-8'?><IamCompanyV2><createdAt>2017-12-01T19:16:41</createdAt><modifiedAt>2017-12-01T19:16:41</modifiedAt><id>1</id><name>Infobip</name><notes>notes example</notes><country>Croatia</country><region>Europe</region><accountManager>Jane Smith</accountManager><customerStage>Testing</customerStage><industry>IT</industry><vatNumber>003212059</vatNumber><customAttributes><Contract Expiry>2018-06-01</Contract Expiry></customAttributes><domains><domains>infobip.com</domains></domains><tags><tags>Vip</tags></tags><origin>API</origin><modifiedFrom>API</modifiedFrom></IamCompanyV2>
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-is-early-access: true
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/companies/batch:
    post:
      tags:
      - customer-engagement
      summary: Batch companies create
      description: Use this method to create multiple companies.<br>**NOTE** Array size of the batch create request is limited to `1000` companies.
      operationId: create-companies
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateRequest'
            examples:
              Batch companies create:
                summary: Batch companies create
                value:
                  companies:
                  - name: Company name
                    notes: Some notes
                    country: Croatia
                    segment: Some segment
                    accountManager: Jane Smith
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                    domains:
                    - domain.com
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateRequest'
            examples:
              Batch companies create:
                summary: Batch companies create
                value: <?xml version='1.0' encoding='UTF-8'?><BatchCreateRequest><companies><companies><name>Company name</name><notes>Some notes</notes><country>Croatia</country><segment>Some segment</segment><accountManager>Jane Smith</accountManager><customAttributes><Contract Expiry>2018-06-01</Contract Expiry></customAttributes><domains><domains>domain.com</domains></domains></companies></companies></BatchCreateRequest>
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse'
              examples:
                Batch companies create:
                  summary: Batch companies create
                  value:
                    results:
                    - status: 200
                      id: 1
                      index: 0
                    - errors:
                      - message: Key (lower(name::text))=(Company name) already exists.
                      status: 409
                      index: 1
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse'
              examples:
                Batch companies create:
                  summary: Batch companies create
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchCreateResponse>\n  <results>\n    <results>\n      <status>200</status>\n      <id>1</id>\n      <index>0</index>\n    </results>\n    <results>\n      <errors>\n        <errors>\n          <message>Key (lower(name::text))=(Company name) already exists.</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <index>1</index>\n    </results>\n  </results>\n</BatchCreateResponse>\n"
        '207':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse'
              examples:
                Batch companies create:
                  summary: Batch companies create
                  value:
                    results:
                    - status: 200
                      id: 1
                      index: 0
                    - errors:
                      - message: Key (lower(name::text))=(Company name) already exists.
                      status: 409
                      index: 1
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse'
              examples:
                Batch companies create:
                  summary: Batch companies create
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchCreateResponse>\n  <results>\n    <results>\n      <status>200</status>\n      <id>1</id>\n      <index>0</index>\n    </results>\n    <results>\n      <errors>\n        <errors>\n          <message>Key (lower(name::text))=(Company name) already exists.</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <index>1</index>\n    </results>\n  </results>\n</BatchCreateResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-is-early-access: true
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Batch companies delete
      description: Use this method to delete multiple companies.<br>**NOTE** Array size of the batch delete request is limited to `1000` companies.
      operationId: delete-companies
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteRequest'
            examples:
              Batch companies delete:
                summary: Batch companies delete
                value:
                  companies:
                  - query:
                      name: Company name
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteRequest'
            examples:
              Batch companies delete:
                summary: Batch companies delete
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchDeleteRequest>\n  <companies>\n    <companies>\n      <query>\n        <name>Company name</name>\n      </query>\n    </companies>\n  </companies>\n</BatchDeleteRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse'
              examples:
                Batch companies delete:
                  summary: Batch companies delete
                  value:
                    results:
                    - errors:
                      - message: Company with name "Company name" does not exist
                      status: 409
                      query:
                        name: Company name
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse'
              examples:
                Batch companies delete:
                  summary: Batch companies delete
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchDeleteResponse>\n  <results>\n    <results>\n      <errors>\n        <errors>\n          <message>Company with name \"Company name\" does not exist</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <query>\n        <name>Company name</name>\n      </query>\n    </results>\n  </results>\n</BatchDeleteResponse>\n"
        '207':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse'
              examples:
                Batch companies delete:
                  summary: Batch companies delete
                  value:
                    results:
                    - errors:
                      - message: Company with name "Company name" does not exist
                      status: 409
                      query:
                        name: Company name
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse'
              examples:
                Batch companies delete:
                  summary: Batch companies delete
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchDeleteResponse>\n  <results>\n    <results>\n      <errors>\n        <errors>\n          <message>Company with name \"Company name\" does not exist</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <query>\n        <name>Company name</name>\n      </query>\n    </results>\n  </results>\n</BatchDeleteResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-is-early-access: true
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Batch companies update
      description: Use this method to update multiple companies.<br>**NOTE** Array size of the batch update request is limited to `1000` companies.
      operationId: update-companies
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  companies:
                    type: array
                    description: List of companies.
                    items:
                      type: object
                      properties:
                        query:
                          allOf:
                          - $ref: '#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.CompanyIdentityQuery'
                        update:
                          allOf:
                          - $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2'
                title: Batch company update
            examples:
              batchCompanyUpdate:
                summary: batchCompanyUpdate
                value:
                  companies:
                  - query:
                      name: Fancy company
                    update:
                      segment: First segment
                      domains:
                      - first-domain.com
                  - query:
                      id: '555'
                    update:
                      segment: Second segment
                      domains:
                      - second-domain.com
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse'
              examples:
                Batch companies update:
                  summary: Batch companies update
                  value:
                    results:
                    - errors:
                      - message: Company with name "Fancy company" does not exist
                      status: 409
                      query:
                        name: Fancy company
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse'
              examples:
                Batch companies update:
                  summary: Batch companies update
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchUpdateResponse>\n  <results>\n    <results>\n      <errors>\n        <errors>\n          <message>Company with name \"Fancy company\" does not exist</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <query>\n        <name>Fancy company</name>\n      </query>\n    </results>\n  </results>\n</BatchUpdateResponse>\n"
        '207':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse'
              examples:
                Batch companies update:
                  summary: Batch companies update
                  value:
                    results:
                    - errors:
                      - message: Company with name "Fancy company" does not exist
                      status: 409
                      query:
                        name: Fancy company
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse'
              examples:
                Batch companies update:
                  summary: Batch companies update
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchUpdateResponse>\n  <results>\n    <results>\n      <errors>\n        <errors>\n          <message>Company with name \"Fancy company\" does not exist</message>\n        </errors>\n      </errors>\n      <status>409</status>\n      <query>\n        <name>Fancy company</name>\n      </query>\n    </results>\n  </results>\n</BatchUpdateResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-is-early-access: true
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/companies/persons:
    delete:
      tags:
      - customer-engagement
      summary: Remove persons from company batch
      description: Use this method to remove persons from a company.<br>**NOTE** Array size is limited to `1000` persons.
      operationId: batch-remove-persons-from-company
      parameters:
      - name: id
        in: query
        description: ID of company you want to remove persons from.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
        example: '11351351'
      - name: externalId
        in: query
        description: External ID of company you want to remove persons from.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '11351351'
      - name: name
        in: query
        description: Name of company you want to remove persons from.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Infobip
      - name: domain
        in: query
        description: Domain of company you want to remove persons from.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: www.infobip.com
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest'
            examples:
              Batch remove persons from company request:
                summary: Batch remove persons from company request
                value:
                  people:
                  - query:
                      type: PHONE
                      identifier: '41793026727'
                  - query:
                      type: EMAIL
                      identifier: johnwilliams@acme.com
                  - query:
                      type: EXTERNAL_ID
                      identifier: '123'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest'
            examples:
              Batch remove persons from company request:
                summary: Batch remove persons from company request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchPersonsToCompanyRequest>\n  <people>\n    <people>\n      <query>\n        <type>PHONE</type>\n        <identifier>41793026727</identifier>\n      </query>\n    </people>\n    <people>\n      <query>\n        <type>EMAIL</type>\n        <identifier>johnwilliams@acme.com</identifier>\n      </query>\n    </people>\n    <people>\n      <query>\n        <type>EXTERNAL_ID</type>\n        <identifier>123</identifier>\n      </query>\n    </people>\n  </people>\n</BatchPersonsToCompanyRequest>\n"
      responses:
        '200':
          description: successful response
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-is-early-access: true
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Add persons to company batch
      description: Use this method to add persons to a company.<br>**NOTE** Array size is limited to `1000` persons.
      operationId: batch-add-persons-to-company
      parameters:
      - name: id
        in: query
        description: ID of company you want to assign persons to.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
        example: '11351351'
      - name: externalId
        in: query
        description: External ID of company you want to assign persons to.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '11351351'
      - name: name
        in: query
        description: Name of company you want to assign persons to.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Infobip
      - name: domain
        in: query
        description: Domain of company you want to assign persons to.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: www.infobip.com
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest'
            examples:
              Batch add persons to company request:
                summary: Batch add persons to company request
                value:
                  people:
                  - query:
                      type: PHONE
                      identifier: '41793026727'
                  - query:
                      type: EMAIL
                      identifier: johnwilliams@acme.com
                  - query:
                      type: EXTERNAL_ID
                      identifier: '123'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest'
            examples:
              Batch add persons to company request:
                summary: Batch add persons to company request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchPersonsToCompanyRequest>\n  <people>\n    <people>\n      <query>\n        <type>PHONE</type>\n        <identifier>41793026727</identifier>\n      </query>\n    </people>\n    <people>\n      <query>\n        <type>EMAIL</type>\n        <identifier>johnwilliams@acme.com</identifier>\n      </query>\n    </people>\n    <people>\n      <query>\n        <type>EXTERNAL_ID</type>\n        <identifier>123</identifier>\n      </query>\n    </people>\n  </people>\n</BatchPersonsToCompanyRequest>\n"
      responses:
        '200':
          description: successful response
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-is-early-access: true
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/tags:
    get:
      tags:
      - customer-engagement
      summary: Get list of tags
      description: Use this method to get a list of tags with pagination.
      operationId: get-list-of-tags
      parameters:
      - name: limit
        in: query
        description: Number of tags to return per page. Default - 20. Maximum - 1000.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: '100'
      - name: page
        in: query
        description: Page of results to return. Default - 1.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: '1'
      - name: orderBy
        in: query
        description: Results ordering. Possible ordering fields are `name`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: name:asc
      - name: includeTotalCount
        in: query
        description: Returns total count of tags, if set to `true`.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: 'false'
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2'
              examples:
                Tag response:
                  summary: Tag response
                  value:
                    createdAt: '2019-02-25T12:46:06'
                    modifiedAt: '2019-02-25T12:46:06'
                    id: 123
                    name: Vip
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2'
              examples:
                Tag response:
                  summary: Tag response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><IamTagV2>\n  <createdAt>2019-02-25T12:46:06</createdAt>\n  <modifiedAt>2019-02-25T12:46:06</modifiedAt>\n  <id>123</id>\n  <name>Vip</name>\n</IamTagV2>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:read
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Create a new tag
      description: Use this method to create a new tag.
      operationId: create-a-new-tag
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2'
            examples:
              Create tag request:
                summary: Create tag request
                value:
                  name: Vip
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2'
            examples:
              Create tag request:
                summary: Create tag request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><IamTagV2>\n  <name>Vip</name>\n</IamTagV2>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2'
              examples:
                Tag response:
                  summary: Tag response
                  value:
                    createdAt: '2019-02-25T12:46:06'
                    modifiedAt: '2019-02-25T12:46:06'
                    id: 123
                    name: Vip
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2'
              examples:
                Tag response:
                  summary: Tag response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><IamTagV2>\n  <createdAt>2019-02-25T12:46:06</createdAt>\n  <modifiedAt>2019-02-25T12:46:06</modifiedAt>\n  <id>123</id>\n  <name>Vip</name>\n</IamTagV2>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/tags/{name}:
    get:
      tags:
      - customer-engagement
      summary: Get a tag
      description: Use this method to get a single tag.
      operationId: get-a-tag
      parameters:
      - name: name
        in: path
        description: Name of the tag.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Vip
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2'
              examples:
                Tag response:
                  summary: Tag response
                  value:
                    createdAt: '2019-02-25T12:46:06'
                    modifiedAt: '2019-02-25T12:46:06'
                    id: 123
                    name: Vip
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2'
              examples:
                Tag response:
                  summary: Tag response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><IamTagV2>\n  <createdAt>2019-02-25T12:46:06</createdAt>\n  <modifiedAt>2019-02-25T12:46:06</modifiedAt>\n  <id>123</id>\n  <name>Vip</name>\n</IamTagV2>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:read
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete a tag
      description: Use this method to delete the existing tag.
      operationId: delete-a-tag
      parameters:
      - name: name
        in: path
        description: Name of the tag.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Vip
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/tags/{name}/persons:
    delete:
      tags:
      - customer-engagement
      summary: Remove tag from people batch
      description: This method allows you to remove tag from multiple people.<br>**NOTE** Array size of the batch remove request is limited to `1000` people.
      operationId: remove-tag-from-people-batch
      parameters:
      - name: name
        in: path
        description: Name of the tag.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Vip
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest'
            examples:
              Batch remove tag from persons request:
                summary: Batch remove tag from persons request
                value:
                  people:
                  - query:
                      type: PHONE
                      identifier: '41793026727'
                  - query:
                      type: EMAIL
                      identifier: johnwilliams@acme.com
                  - query:
                      type: EXTERNAL_ID
                      identifier: '123'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest'
            examples:
              Batch remove tag from persons request:
                summary: Batch remove tag from persons request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchTagRequest>\n  <people>\n    <people>\n      <query>\n        <type>PHONE</type>\n        <identifier>41793026727</identifier>\n      </query>\n    </people>\n    <people>\n      <query>\n        <type>EMAIL</type>\n        <identifier>johnwilliams@acme.com</identifier>\n      </query>\n    </people>\n    <people>\n      <query>\n        <type>EXTERNAL_ID</type>\n        <identifier>123</identifier>\n      </query>\n    </people>\n  </people>\n</BatchTagRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Add tag to people batch
      description: This method allows you to assign tag to multiple people.<br>**NOTE** Array size of the batch add request is limited to `1000` people.
      operationId: add-tag-to-people-batch
      parameters:
      - name: name
        in: path
        description: Name of the tag.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Vip
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest'
            examples:
              Batch add tag to persons request:
                summary: Batch add tag to persons request
                value:
                  people:
                  - query:
                      type: PHONE
                      identifier: '41793026727'
                  - query:
                      type: EMAIL
                      identifier: johnwilliams@acme.com
                  - query:
                      type: EXTERNAL_ID
                      identifier: '123'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest'
            examples:
              Batch add tag to persons request:
                summary: Batch add tag to persons request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BatchTagRequest>\n  <people>\n    <people>\n      <query>\n        <type>PHONE</type>\n        <identifier>41793026727</identifier>\n      </query>\n    </people>\n    <people>\n      <query>\n        <type>EMAIL</type>\n        <identifier>johnwilliams@acme.com</identifier>\n      </query>\n    </people>\n    <people>\n      <query>\n        <type>EXTERNAL_ID</type>\n        <identifier>123</identifier>\n      </query>\n    </people>\n  </people>\n</BatchTagRequest>\n"
      responses:
        '200':
          description: successful response
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/customAttributes:
    get:
      tags:
      - customer-engagement
      summary: Get a list of custom attributes
      description: Get a list of custom attributes using this method.
      operationId: get-a-list-of-custom-attributes
      parameters:
      - name: limit
        in: query
        description: Number of custom attributes to return per page. Default - 20. Maximum - 1000.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: '100'
      - name: page
        in: query
        description: Page of results to return. Default - 1.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: '1'
      - name: includeTotalCount
        in: query
        description: Returns total count of custom attributes, if set to `true`.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: 'false'
      - name: orderBy
        in: query
        description: Results ordering. Possible ordering fields are `name`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: name:asc
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.CustomAttributesResponse'
              examples:
                Response for get custom attributes request.:
                  summary: Response for get custom attributes request.
                  value:
                    limit: 100
                    page: 1
                    orderBy: name:asc
                    customAttributes:
                    - createdAt: '2019-02-25T12:46:06'
                      modifiedAt: '2019-02-25T12:46:06'
                      name: Contract Expiry Date
                      dataType: DATE
                    - createdAt: '2019-02-25T12:46:06'
                      modifiedAt: '2019-02-25T12:46:06'
                      name: ShoppingCartList
                      dataType: LIST_OF_OBJECTS
                      objectSchema:
                        productName: STRING
                        productPrice: DECIMAL
                        productCategory: STRING
                        productImage: STRING
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.CustomAttributesResponse'
              examples:
                Response for get custom attributes request.:
                  summary: Response for get custom attributes request.
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><CustomAttributesResponse>\n  <limit>100</limit>\n  <page>1</page>\n  <orderBy>name:asc</orderBy>\n  <customAttributes>\n    <customAttributes>\n      <createdAt>2019-02-25T12:46:06</createdAt>\n      <modifiedAt>2019-02-25T12:46:06</modifiedAt>\n      <name>Contract Expiry Date</name>\n      <dataType>DATE</dataType>\n    </customAttributes>\n    <customAttributes>\n      <createdAt>2019-02-25T12:46:06</createdAt>\n      <modifiedAt>2019-02-25T12:46:06</modifiedAt>\n      <name>ShoppingCartList</name>\n      <dataType>LIST_OF_OBJECTS</dataType>\n      <objectSchema>\n        <productName>STRING</productName>\n        <productPrice>DECIMAL</productPrice>\n        <productCategory>STRING</productCategory>\n        <productImage>STRING</productImage>\n      </objectSchema>\n    </customAttributes>\n  </customAttributes>\n</CustomAttributesResponse>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:read
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Create a custom attribute
      description: Create a new custom attribute by using this method.
      operationId: create-a-custom-attribute
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute'
            examples:
              Create custom attribute.:
                summary: Create custom attribute.
                value:
                  name: Contract Expiry Date
                  dataType: DATE
              Create custom attribute with type "LIST_OF_OBJECTS".:
                summary: Create custom attribute with type "LIST_OF_OBJECTS".
                value:
                  name: ShoppingCartList
                  dataType: LIST_OF_OBJECTS
                  objectSchema:
                    productName: STRING
                    productPrice: DECIMAL
                    productCategory: STRING
                    productImage: STRING
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute'
            examples:
              Create custom attribute.:
                summary: Create custom attribute.
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><IamCustomAttribute>\n  <name>Contract Expiry Date</name>\n  <dataType>DATE</dataType>\n</IamCustomAttribute>\n"
              Create custom attribute with type "LIST_OF_OBJECTS".:
                summary: Create custom attribute with type "LIST_OF_OBJECTS".
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><IamCustomAttribute>\n  <name>ShoppingCartList</name>\n  <dataType>LIST_OF_OBJECTS</dataType>\n  <objectSchema>\n    <productName>STRING</productName>\n    <productPrice>DECIMAL</productPrice>\n    <productCategory>STRING</productCategory>\n    <productImage>STRING</productImage>\n  </objectSchema>\n</IamCustomAttribute>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute'
              examples:
                Response for create custom attribute request.:
                  summary: Response for create custom attribute request.
                  value:
                    createdAt: '2019-02-25T12:46:06'
                    modifiedAt: '2019-02-25T12:46:06'
                    name: Contract Expiry Date
                    dataType: DATE
                Response for create custom attribute with type "LIST_OF_OBJECTS" request.:
                  summary: Response for create custom attribute with type "LIST_OF_OBJECTS" request.
                  value:
                    createdAt: '2019-02-25T12:46:06'
                    modifiedAt: '2019-02-25T12:46:06'
                    name: ShoppingCartList
                    dataType: LIST_OF_OBJECTS
                    objectSchema:
                      productName: STRING
                      productPrice: DECIMAL
                      productCategory: STRING
                      productImage: STRING
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute'
              examples:
                Response for create custom attribute request.:
                  summary: Response for create custom attribute request.
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><IamCustomAttribute>\n  <createdAt>2019-02-25T12:46:06</createdAt>\n  <modifiedAt>2019-02-25T12:46:06</modifiedAt>\n  <name>Contract Expiry Date</name>\n  <dataType>DATE</dataType>\n</IamCustomAttribute>\n"
                Response for create custom attribute with type "LIST_OF_OBJECTS" request.:
                  summary: Response for create custom attribute with type "LIST_OF_OBJECTS" request.
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><IamCustomAttribute>\n  <createdAt>2019-02-25T12:46:06</createdAt>\n  <modifiedAt>2019-02-25T12:46:06</modifiedAt>\n  <name>ShoppingCartList</name>\n  <dataType>LIST_OF_OBJECTS</dataType>\n  <objectSchema>\n    <productName>STRING</productName>\n    <productPrice>DECIMAL</productPrice>\n    <productCategory>STRING</productCategory>\n    <productImage>STRING</productImage>\n  </objectSchema>\n</IamCustomAttribute>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/customAttributes/{name}:
    get:
      tags:
      - customer-engagement
      summary: Get a single custom attribute
      description: Get a single custom attribute using this method.
      operationId: get-a-single-custom-attribute
      parameters:
      - name: name
        in: path
        description: Name of the attribute.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Contract Expiry Date
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute'
              examples:
                Response for get custom attribute request.:
                  summary: Response for get custom attribute request.
                  value:
                    createdAt: '2019-02-25T12:46:06'
                    modifiedAt: '2019-02-25T12:46:06'
                    name: Contract Expiry Date
                    dataType: DATE
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute'
              examples:
                Response for get custom attribute request.:
                  summary: Response for get custom attribute request.
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><IamCustomAttribute>\n  <createdAt>2019-02-25T12:46:06</createdAt>\n  <modifiedAt>2019-02-25T12:46:06</modifiedAt>\n  <name>Contract Expiry Date</name>\n  <dataType>DATE</dataType>\n</IamCustomAttribute>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:read
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete a custom attribute
      description: Use this method to delete the custom attribute
      operationId: delete-a-custom-attribute
      parameters:
      - name: name
        in: path
        description: Name of the attribute you want to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Attribute
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/customAttributes/{name}/append:
    post:
      tags:
      - customer-engagement
      summary: Append item to custom attribute
      description: Custom attributes with `LIST_OF_OBJECTS` type contain an array of items as a value. Using this API method, you can add a new item to the specified list type custom attribute of a specific person. The item you want to add should match the defined list schema.
      operationId: append-item-to-custom-attribute
      parameters:
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '370329180020364'
      - name: sender
        in: query
        description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2094832040560427'
      - name: type
        in: query
        description: Type of the person ID
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
        example: PHONE
      - name: name
        in: path
        description: Name of the list type custom attribute
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: ShoppingCartList
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              appendItemToList:
                summary: Append new item to person's existing list
                description: Add new item to the person’s existing list type custom attribute (e.g. “ShoppingCartList”).
                value:
                  productName: Cap
                  productPrice: 11.33
                  productCategory: Hats
                  productImage: /image3.png
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                type: array
                items: {}
              examples:
                appendItemToList:
                  summary: Append new item to person's existing list
                  description: Response when adding a new item to “ShoppingCartList” list type custom attribute (contains the whole person’s “ShoppingCartList” list, including appended item).
                  value:
                  - productName: Sneakers
                    productPrice: 25.33
                    productCategory: Sport Sneakers
                    productImage: /image1.png
                  - productName: T-Shirt
                    productPrice: 9.99
                    productCategory: Casual
                    productImage: /image2.png
                  - productName: Cap
                    productPrice: 11.33
                    productCategory: Hats
                    productImage: /image3.png
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/3/lists/{listName}/items:
    get:
      tags:
      - customer-engagement
      summary: Get items
      description: Get a single item or a list of items of a list attribute.
      operationId: get-list-items
      parameters:
      - name: listName
        in: path
        description: Name of the list attribute.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: type
        in: query
        description: Type of the person ID. Can be one of the above.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Person ID. ID type must match the `type` parameter.
      - name: sender
        in: query
        description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
      - name: itemIds
        in: query
        description: UUIDs of list items to return, separated by commas (,).
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    item_field_#1: some value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    item_field_#1: some value
                    item_field_#2: 42
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                identifier is not provided:
                  summary: identifier is not provided
                  description: identifier is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: identifier'
                type is not provided:
                  summary: type is not provided
                  description: type is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: type'
                itemIds are not provided:
                  summary: itemIds are not provided
                  description: itemIds are not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: itemIds'
                sender shouldn't be provided:
                  summary: sender shouldn't be provided
                  description: sender shouldn't be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender shouldn't be specified
                sender should be provided:
                  summary: sender should be provided
                  description: sender should be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender should be specified
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              examples:
                person doesn't exist:
                  summary: person doesn't exist
                  description: person doesn't exist
                  value:
                    errorCode: 300101
                    message: Person with ID 'test@gmail.com' does not exist
                placeholder doesn't exist:
                  summary: placeholder doesn't exist
                  description: placeholder doesn't exist
                  value:
                    errorCode: 300103
                    message: Placeholder with name "missing list" does not exist
                list items with given name don't exist:
                  summary: list items with given name don't exist
                  description: list items with given name don't exist
                  value:
                    errorCode: 300130
                    message: Items of list of objects are not found [listName = my list, itemIds=[b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f]]
                list items with given itemIds don't exist:
                  summary: list items with given itemIds don't exist
                  description: list items with given itemIds don't exist
                  value:
                    errorCode: 300130
                    message: Items of list of object are not found [listName = my list, itemIds=[83a511bf-a478-4db2-be4f-e46cd187626d, 2a963012-dd58-414c-b751-32625ec6909]]
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:read
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Append items
      description: Adds new items to a list attribute and returns all items of the updated list.
      operationId: append-list-items
      parameters:
      - name: listName
        in: path
        description: Name of the list attribute.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: type
        in: query
        description: Type of the person ID. Can be one of the above.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Person ID. ID type must match the `type` parameter.
      - name: sender
        in: query
        description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                description: Items to append.<br>Can't be less than 1 and more than 128 items.<br>Item IDs are not allowed.
            examples:
              Request example:
                summary: Request example
                value:
                - item_field_#1: some value
                  item_field_#2: 42
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    item_field_#1: some value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    item_field_#1: some value
                    item_field_#2: 42
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                identifier is not provided:
                  summary: identifier is not provided
                  description: identifier is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: identifier'
                type is not provided:
                  summary: type is not provided
                  description: type is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: type'
                sender shouldn't be provided:
                  summary: sender shouldn't be provided
                  description: sender shouldn't be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender shouldn't be specified
                sender should be provided:
                  summary: sender should be provided
                  description: sender should be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender should be specified
                incorrect field value is provided:
                  summary: incorrect field value is provided
                  description: incorrect field value is provided
                  value:
                    errorCode: 300109
                    message: Invalid field value for <item_field_name>, value <1>, type <class java.lang.Integer>, expected <STRING>, but got <INTEGER>
                item ids shouldn't be passed:
                  summary: item ids shouldn't be passed
                  description: item ids shouldn't be passed
                  value:
                    errorCode: 429002
                    message: Item ids shouldn't be passed
                request body shouldn't be empty:
                  summary: request body shouldn't be empty
                  description: request body shouldn't be empty
                  value:
                    errorCode: 400101
                    message: 'Validation errors: property items - size must be between 1 and 128'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              examples:
                person doesn't exist:
                  summary: person doesn't exist
                  description: person doesn't exist
                  value:
                    errorCode: 300101
                    message: Person with ID 'test@gmail.com' does not exist
                placeholder doesn't exist:
                  summary: placeholder doesn't exist
                  description: placeholder doesn't exist
                  value:
                    errorCode: 300103
                    message: Placeholder with name "missing list" does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete items
      description: Deletes items in a list attribute and returns all items of the updated list.
      operationId: delete-list-items
      parameters:
      - name: listName
        in: path
        description: Name of the list attribute.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: type
        in: query
        description: Type of the person ID. Can be one of the above.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Person ID. ID type must match the `type` parameter.
      - name: sender
        in: query
        description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
      - name: itemIds
        in: query
        description: UUIDs of list items to delete, separated by commas (,).
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 1d543ae8-957d-4fe6-b0f4-ad3ce1eb5bbf
                    item_field_#1: some value
                  - __id: 844011e5-8c0d-4447-b67f-499bb9ff2783
                    item_field_#1: some value
                    item_field_#2: 42
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                identifier is not provided:
                  summary: identifier is not provided
                  description: identifier is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: identifier'
                type is not provided:
                  summary: type is not provided
                  description: type is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: type'
                itemIds are not provided:
                  summary: itemIds are not provided
                  description: itemIds are not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: itemIds'
                sender shouldn't be provided:
                  summary: sender shouldn't be provided
                  description: sender shouldn't be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender shouldn't be specified
                sender should be provided:
                  summary: sender should be provided
                  description: sender should be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender should be specified
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              examples:
                person doesn't exist:
                  summary: person doesn't exist
                  description: person doesn't exist
                  value:
                    errorCode: 300101
                    message: Person with ID 'test@gmail.com' does not exist
                placeholder doesn't exist:
                  summary: placeholder doesn't exist
                  description: placeholder doesn't exist
                  value:
                    errorCode: 300103
                    message: Placeholder with name "missing list" does not exist
                list items with given name don't exist:
                  summary: list items with given name don't exist
                  description: list items with given name don't exist
                  value:
                    errorCode: 300130
                    message: Items of list of objects are not found [listName = my list, itemIds=[b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f]]
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
  /people/3/lists/{listName}/items/{itemId}:
    put:
      tags:
      - customer-engagement
      summary: Replace an item
      description: Replaces an item of a list attribute and returns all items of the updated list.
      operationId: replace-list-item
      parameters:
      - name: listName
        in: path
        description: Name of the list attribute.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: itemId
        in: path
        description: UUID of the list item to replace.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: type
        in: query
        description: Type of the person ID. Can be one of the above.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Person ID. ID type must match the `type` parameter.
      - name: sender
        in: query
        description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Item fields for replace.<br>Can't be less than 1 and more than 128 fields.<br>If value of a field explicitly passed as NULL, it will delete a current value of the field.
            examples:
              Request example:
                summary: Request example
                value:
                  item_field_#1: new field value
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    item_field_#1: new field value
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                identifier is not provided:
                  summary: identifier is not provided
                  description: identifier is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: identifier'
                type is not provided:
                  summary: type is not provided
                  description: type is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: type'
                itemId isn't UUID:
                  summary: itemId isn't UUID
                  description: itemId isn't UUID
                  value:
                    errorCode: 429002
                    message: 'Item id is invalid: 123456L'
                sender shouldn't be provided:
                  summary: sender shouldn't be provided
                  description: sender shouldn't be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender shouldn't be specified
                sender should be provided:
                  summary: sender should be provided
                  description: sender should be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender should be specified
                incorrect field value is provided:
                  summary: incorrect field value is provided
                  description: incorrect field value is provided
                  value:
                    errorCode: 300109
                    message: Invalid field value for <item_field_name>, value <1>, type <class java.lang.Integer>, expected <STRING>, but got <INTEGER>
                request body shouldn't be empty:
                  summary: request body shouldn't be empty
                  description: request body shouldn't be empty
                  value:
                    errorCode: 400101
                    message: 'Validation errors: property items - size must be between 1 and 128'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              examples:
                person doesn't exist:
                  summary: person doesn't exist
                  description: person doesn't exist
                  value:
                    errorCode: 300101
                    message: Person with ID 'test@gmail.com' does not exist
                placeholder doesn't exist:
                  summary: placeholder doesn't exist
                  description: placeholder doesn't exist
                  value:
                    errorCode: 300103
                    message: Placeholder with name "missing list" does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Update an item
      description: 'Updates the fields of a list item that are passed in the request.

        Missing fields will keep their values.

        Returns all items of the updated list attribute.'
      operationId: update-list-item
      parameters:
      - name: listName
        in: path
        description: Name of the list attribute.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: itemId
        in: path
        description: UUID of the list item to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: type
        in: query
        description: Type of the person ID. Can be one of the above.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Person ID. ID type must match the `type` parameter.
      - name: sender
        in: query
        description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Item fields for update.<br>Can't be less than 1 and more than 128 fields.<br>If value of a field explicitly passed as NULL, it will delete a current value of the field.
            examples:
              Request example:
                summary: Request example
                value:
                  item_field_#1: new field value
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    item_field_#1: new field value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    item_field_#1: some value
                    item_field_#2: 42
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                identifier is not provided:
                  summary: identifier is not provided
                  description: identifier is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: identifier'
                type is not provided:
                  summary: type is not provided
                  description: type is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: type'
                sender shouldn't be provided:
                  summary: sender shouldn't be provided
                  description: sender shouldn't be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender shouldn't be specified
                sender should be provided:
                  summary: sender should be provided
                  description: sender should be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender should be specified
                incorrect field value is provided:
                  summary: incorrect field value is provided
                  description: incorrect field value is provided
                  value:
                    errorCode: 300109
                    message: Invalid field value for <item_field_name>, value <1>, type <class java.lang.Integer>, expected <STRING>, but got <INTEGER>
                request body shouldn't be empty:
                  summary: request body shouldn't be empty
                  description: request body shouldn't be empty
                  value:
                    errorCode: 400101
                    message: 'Validation errors: property items - size must be between 1 and 128'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              examples:
                person doesn't exist:
                  summary: person doesn't exist
                  description: person doesn't exist
                  value:
                    errorCode: 300101
                    message: Person with ID 'test@gmail.com' does not exist
                placeholder doesn't exist:
                  summary: placeholder doesn't exist
                  description: placeholder doesn't exist
                  value:
                    errorCode: 300103
                    message: Placeholder with name "missing list" does not exist
                list items with given name don't exist:
                  summary: list items with given name don't exist
                  description: list items with given name don't exist
                  value:
                    errorCode: 300130
                    message: Items of list of objects are not found [listName = my list, itemIds=[b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f]]
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
  /people/3/lists:
    get:
      tags:
      - customer-engagement
      summary: Get lists
      description: Returns all items of a single or multiple list attributes.
      operationId: get-lists
      parameters:
      - name: listNames
        in: query
        description: Names of list attributes to return, separated by commas (,).
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: type
        in: query
        description: Type of the person ID. Can be one of the above.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Person ID. ID type must match the `type` parameter.
      - name: sender
        in: query
        description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    my list:
                    - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                      item_field_#1: some value
                    - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                      item_field_#1: some value
                      item_field_#2: 42
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                identifier is not provided:
                  summary: identifier is not provided
                  description: identifier is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: identifier'
                type is not provided:
                  summary: type is not provided
                  description: type is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: type'
                sender shouldn't be provided:
                  summary: sender shouldn't be provided
                  description: sender shouldn't be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender shouldn't be specified
                sender should be provided:
                  summary: sender should be provided
                  description: sender should be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender should be specified
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              examples:
                person doesn't exist:
                  summary: person doesn't exist
                  description: person doesn't exist
                  value:
                    errorCode: 300101
                    message: Person with ID 'test@gmail.com' does not exist
                placeholder doesn't exist:
                  summary: placeholder doesn't exist
                  description: placeholder doesn't exist
                  value:
                    errorCode: 300103
                    message: Placeholder with name "missing list" does not exist
                placeholders don't exist:
                  summary: placeholders don't exist
                  description: placeholders don't exist
                  value:
                    errorCode: 300103
                    message: Placeholders with names [my list, my second list] do not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:read
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete lists
      description: Deletes a single or multiple list attributes of a profile.
      operationId: delete-lists
      parameters:
      - name: listNames
        in: query
        description: Names of list attributes to delete, separated by commas (,).
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: type
        in: query
        description: Type of the person ID. Can be one of the above.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Person ID. ID type must match the `type` parameter.
      - name: sender
        in: query
        description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
      responses:
        '204':
          description: Success
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                identifier is not provided:
                  summary: identifier is not provided
                  description: identifier is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: identifier'
                type is not provided:
                  summary: type is not provided
                  description: type is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: type'
                sender shouldn't be provided:
                  summary: sender shouldn't be provided
                  description: sender shouldn't be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender shouldn't be specified
                sender should be provided:
                  summary: sender should be provided
                  description: sender should be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender should be specified
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              examples:
                person doesn't exist:
                  summary: person doesn't exist
                  description: person doesn't exist
                  value:
                    errorCode: 300101
                    message: Person with ID 'test@gmail.com' does not exist
                placeholder doesn't exist:
                  summary: placeholder doesn't exist
                  description: placeholder doesn't exist
                  value:
                    errorCode: 300103
                    message: Placeholder with name "missing list" does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
  /people/3/lists/{listName}:
    put:
      tags:
      - customer-engagement
      summary: Replace a list
      description: Replaces all items in a list attribute and returns all items of the updated list.
      operationId: replace-list
      parameters:
      - name: listName
        in: path
        description: Name of the list attribute.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: type
        in: query
        description: Type of the person ID. Can be one of the above.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Person ID. ID type must match the `type` parameter.
      - name: sender
        in: query
        description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                description: Items data for replace.<br>Can't be less than 1 and more than 128 items.<br>Identifiers of items are not allowed in a body.
            examples:
              Request example:
                summary: Request example
                value:
                - item_field_#1: some value
                  item_field_#2: 42
                - item_field_#1: some value
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    item_field_#1: some value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    item_field_#1: some value
                    item_field_#2: 42
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                identifier is not provided:
                  summary: identifier is not provided
                  description: identifier is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: identifier'
                type is not provided:
                  summary: type is not provided
                  description: type is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: type'
                sender shouldn't be provided:
                  summary: sender shouldn't be provided
                  description: sender shouldn't be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender shouldn't be specified
                sender should be provided:
                  summary: sender should be provided
                  description: sender should be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender should be specified
                item ids shouldn't be passed:
                  summary: item ids shouldn't be passed
                  description: item ids shouldn't be passed
                  value:
                    errorCode: 429002
                    message: Item ids shouldn't be passed
                incorrect field value is provided:
                  summary: incorrect field value is provided
                  description: incorrect field value is provided
                  value:
                    errorCode: 300109
                    message: Invalid field value for <item_field_name>, value <1>, type <class java.lang.Integer>, expected <STRING>, but got <INTEGER>
                request body shouldn't be empty:
                  summary: request body shouldn't be empty
                  description: request body shouldn't be empty
                  value:
                    errorCode: 400101
                    message: 'Validation errors: property items - size must be between 1 and 128'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              examples:
                person doesn't exist:
                  summary: person doesn't exist
                  description: person doesn't exist
                  value:
                    errorCode: 300101
                    message: Person with ID 'test@gmail.com' does not exist
                placeholder doesn't exist:
                  summary: placeholder doesn't exist
                  description: placeholder doesn't exist
                  value:
                    errorCode: 300103
                    message: Placeholder with name "missing list" does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Update a list
      description: 'Updates the fields of list items passed in the request.

        Missing items and fields will keep their values.

        Returns all items of the updated list.'
      operationId: update-list
      parameters:
      - name: listName
        in: path
        description: Name of the list attribute.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: type
        in: query
        description: Type of the person ID. Can be one of the above.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Person ID. ID type must match the `type` parameter.
      - name: sender
        in: query
        description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                description: Items data for update.<br>Can't be less than 1 and more than 128 items.<br>New item IDs are not allowed.<br>Items without existing ids in are not allowed<br>If value of a field explicitly passed as NULL, it will delete a current value of the field.
            examples:
              Request example:
                summary: Request example
                value:
                - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                  item_field_#1: new value
                  item_field_#2: null
                - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                  item_field_#1: new value
                  item_field_#2: 42
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    item_field_#1: new value
                    item_field_#3: old value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    item_field_#1: new value
                    item_field_#2: 42
                    item_field_#3: old value
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                identifier is not provided:
                  summary: identifier is not provided
                  description: identifier is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: identifier'
                type is not provided:
                  summary: type is not provided
                  description: type is not provided
                  value:
                    errorCode: 400116
                    message: 'Missing parameter: type'
                sender shouldn't be provided:
                  summary: sender shouldn't be provided
                  description: sender shouldn't be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender shouldn't be specified
                sender should be provided:
                  summary: sender should be provided
                  description: sender should be provided
                  value:
                    errorCode: 400117
                    message: For type [TYPE] sender should be specified
                item ids should be passed:
                  summary: item ids should be passed
                  description: item ids should be passed
                  value: '{"errorCode": 429002, "message": "Ids should be presented for an every item: {"item_field_#1": "new value"}"}'
                incorrect field value is provided:
                  summary: incorrect field value is provided
                  description: incorrect field value is provided
                  value:
                    errorCode: 300109
                    message: Invalid field value for <item_field_name>, value <1>, type <class java.lang.Integer>, expected <STRING>, but got <INTEGER>
                request body shouldn't be empty:
                  summary: request body shouldn't be empty
                  description: request body shouldn't be empty
                  value:
                    errorCode: 400101
                    message: 'Validation errors: property items - size must be between 1 and 128'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              examples:
                person doesn't exist:
                  summary: person doesn't exist
                  description: person doesn't exist
                  value:
                    errorCode: 300101
                    message: Person with ID 'test@gmail.com' does not exist
                placeholder doesn't exist:
                  summary: placeholder doesn't exist
                  description: placeholder doesn't exist
                  value:
                    errorCode: 300103
                    message: Placeholder with name "missing list" does not exist
                list items with given itemIds don't exist:
                  summary: list items with given itemIds don't exist
                  description: list items with given itemIds don't exist
                  value:
                    errorCode: 300130
                    message: Items of list of objects are not found [listName = my list, itemIds=[b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f]]
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/persons/{personId}/lists/{listName}/items:
    get:
      tags:
      - customer-engagement
      summary: Get items
      description: Returns a single item or set of items of a list.
      operationId: deprecated-get-list-items
      parameters:
      - name: personId
        in: path
        description: Person's internal ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: listName
        in: path
        description: Name given to a list.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: itemIds
        in: query
        description: List of identifiers for items. Every identifier should be UUID.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Item(s) found
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    field1: field value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    field1: field value
        '400':
          description: 'Bad request: missing or invalid parameter'
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: <ul><li>no profile with a given personId</li><li>no custom attribute with a given listName</li><li>no instance of a list with a given listName</li><li>no items with given itemIds in a list</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-is-early-access: 'true'
      x-scopes:
      - people:read
      - people:manage
      x-deprecationInformation:
        deprecation: '2023-10-25T00:00:00.000+00:00'
        sunset: '2024-01-25T00:00:00.000+00:00'
        successorOperationId: get-list-items
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Append items
      description: Adds new items to a list and returns all items of the updated list.
      operationId: deprecated-append-list-items
      parameters:
      - name: personId
        in: path
        description: Person's internal ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: listName
        in: path
        description: Name given to a list.<br>If an instance of a list doesn't exist for a person, the list instance will be created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                description: Items to append.<br>Can't be less than 1 and more than 128 items.<br>Item IDs are not allowed.
            examples:
              Request example:
                summary: Request example
                value:
                - field1: field value
                - field1: field value
        required: true
      responses:
        '200':
          description: Items appended
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    field1: field value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    field1: field value
        '400':
          description: Bad request:<ul><li>empty body</li><li>__id fields passed</li><li>fields undefined in the list schema passed</li><li>unexpected type of a field value passed</li><li>size of the resulting list exceeds 128 items</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: <ul><li>no profile with a given personId</li><li>no custom attribute with a given list name</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-is-early-access: 'true'
      x-scopes:
      - people:manage
      x-deprecationInformation:
        deprecation: '2023-10-25T00:00:00.000+00:00'
        sunset: '2024-01-25T00:00:00.000+00:00'
        successorOperationId: append-list-items
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete items
      description: Deletes items with given identifiers and returns rest items of the updated list.
      operationId: deprecated-delete-list-items
      parameters:
      - name: personId
        in: path
        description: Person's internal ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: listName
        in: path
        description: Name given to a list.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: itemIds
        in: query
        description: List of identifiers for items. Every identifier should be UUID.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Items deleted
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 1d543ae8-957d-4fe6-b0f4-ad3ce1eb5bbf
                    field1: field value
                  - __id: 844011e5-8c0d-4447-b67f-499bb9ff2783
                    field1: field value
        '400':
          description: 'Bad request: missing or invalid parameter'
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: <ul><li>no profile with a given personId</li><li>no custom attribute with a given listName</li><li>no instance of a list with a given listName</li><li>no items with given itemIds in a list</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-is-early-access: 'true'
      x-scopes:
      - people:manage
      x-deprecationInformation:
        deprecation: '2023-10-25T00:00:00.000+00:00'
        sunset: '2024-01-25T00:00:00.000+00:00'
        successorOperationId: delete-list-items
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/persons/{personId}/lists/{listName}/items/{itemId}:
    put:
      tags:
      - customer-engagement
      summary: Replace an item
      description: Replaces an item of a list and returns all items of the updated list.
      operationId: deprecated-replace-list-item
      parameters:
      - name: personId
        in: path
        description: Person's internal ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: listName
        in: path
        description: Name given to a list.<br>If an instance of a list doesn't exist for a person, the list instance will be created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: itemId
        in: path
        description: Identifier of an item to replace.<br>Identifier should be UUID.<br>Value of __id-field passed in a body will be replaced by the current value.<br>If an item with a given identifier doesn't exist, it will be created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Item fields for replace.<br>Can't be less than 1 and more than 128 fields.<br>If value of a field explicitly passed as NULL, it will delete a current value of the field.
            examples:
              Request example:
                summary: Request example
                value:
                  __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                  field1: new field value
        required: true
      responses:
        '200':
          description: Item fields replaced
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    field1: new field value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    field1: field value
        '400':
          description: Bad request:<ul><li>empty body</li><li>passed itemId can't be parsed as UUID</li><li>fields undefined in the list schema passed</li><li>unexpected type of a field value passed</li><li>size of the resulting list exceeds 128 items</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: <ul><li>no profile with a given personId</li><li>no custom attribute with a given listName</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-is-early-access: 'true'
      x-scopes:
      - people:manage
      x-deprecationInformation:
        deprecation: '2023-10-25T00:00:00.000+00:00'
        sunset: '2024-01-25T00:00:00.000+00:00'
        successorOperationId: replace-list-item
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Update an item
      description: Updates only fields of the item that are presented in a given data.<br>Missing fields will be preserved.<br>Returns all items of the updated list.
      operationId: deprecated-update-list-item
      parameters:
      - name: personId
        in: path
        description: Person's internal ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: listName
        in: path
        description: Name given to a list.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: itemId
        in: path
        description: Identifier of an item to update.<br>Identifier should be UUID.<br>Value of __id-field passed in a body will be replaced by the current value.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Item fields for update.<br>Can't be less than 1 and more than 128 fields.<br>If value of a field explicitly passed as NULL, it will delete a current value of the field.
            examples:
              Request example:
                summary: Request example
                value:
                  __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                  field1: new field value
        required: true
      responses:
        '200':
          description: Item fields updated
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    field1: new field value
                    field2: old field value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    field1: field value
                    field2: field value
        '400':
          description: Bad request:<ul><li>empty body</li><li>passed itemId can't be parsed as UUID</li><li>fields undefined in the list schema passed</li><li>unexpected type of a field value passed</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: <ul><li>no profile with a given personId</li><li>no custom attribute with a given listName</li><li>no instance of a list with a given listName</li><li>no items with a given itemId in a list</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-is-early-access: 'true'
      x-scopes:
      - people:manage
      x-deprecationInformation:
        deprecation: '2023-10-25T00:00:00.000+00:00'
        sunset: '2024-01-25T00:00:00.000+00:00'
        successorOperationId: update-list-item
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/persons/{personId}/lists:
    get:
      tags:
      - customer-engagement
      summary: Get lists
      description: Returns all items of a single list or sets of items of a set of lists.
      operationId: deprecated-get-lists
      parameters:
      - name: personId
        in: path
        description: Person's internal ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: listNames
        in: query
        description: Names given to lists.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Lists found
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    list1:
                    - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                      field1: field value
                    - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                      field1: field value
                    list2:
                    - __id: 1d543ae8-957d-4fe6-b0f4-ad3ce1eb5bbf
                      field1: field value
                    - __id: 844011e5-8c0d-4447-b67f-499bb9ff2783
                      field1: field value
        '400':
          description: 'Bad request: missing or invalid parameter'
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: <ul><li>no profile with a given personId</li><li>no custom attributes with given listNames</li><li>no instances of list with given listNames</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-is-early-access: 'true'
      x-scopes:
      - people:read
      - people:manage
      x-deprecationInformation:
        deprecation: '2023-10-25T00:00:00.000+00:00'
        sunset: '2024-01-25T00:00:00.000+00:00'
        successorOperationId: get-lists
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete lists
      description: Deletes a single list instance or set of lists instanses for a person.
      operationId: deprecated-delete-lists
      parameters:
      - name: personId
        in: path
        description: Person's internal ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      - name: listNames
        in: query
        description: Names given to lists.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '204':
          description: Lists deleted
        '400':
          description: 'Bad request: missing or invalid parameter'
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: <ul><li>no profile with a given personId</li><li>no custom attribute with a given listName</li><li>no instance of a list with a given listName</li><li>no items with given itemIds in a list</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-is-early-access: 'true'
      x-scopes:
      - people:manage
      x-deprecationInformation:
        deprecation: '2023-10-25T00:00:00.000+00:00'
        sunset: '2024-01-25T00:00:00.000+00:00'
        successorOperationId: delete-lists
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/persons/{personId}/lists/{listName}:
    put:
      tags:
      - customer-engagement
      summary: Replace a list
      description: Replaces a list and returns all items of the updated list.
      operationId: deprecated-replace-list
      parameters:
      - name: personId
        in: path
        description: Person's internal ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: listName
        in: path
        description: Name given to a list.<br>If an instance of a list doesn't exist for a person, the list instance will be created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                description: Items data for replace.<br>Can't be less than 1 and more than 128 items.<br>Identifiers of items are not allowed in a body.
            examples:
              Request example:
                summary: Request example
                value:
                - field1: new field value
                - field1: new field value
        required: true
      responses:
        '200':
          description: Items are replaced
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    field1: field value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    field1: field value
        '400':
          description: Bad request:<ul><li>empty body</li><li>__id fields passed</li><li>fields undefined in the list schema passed</li><li>unexpected type of a field value passed</li><li>size of the resulting list exceeds 128 items</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: <ul><li>no profile with a given personId</li><li>no custom attributes with given listNames</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-is-early-access: 'true'
      x-scopes:
      - people:manage
      x-deprecationInformation:
        deprecation: '2023-10-25T00:00:00.000+00:00'
        sunset: '2024-01-25T00:00:00.000+00:00'
        successorOperationId: replace-list
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Update a list
      description: Updates only items and fields for a given data set.<br>Missing items and fields will be preserved.<br>Returns all items of the updated list.
      operationId: deprecated-update-list
      parameters:
      - name: personId
        in: path
        description: Person's internal ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: listName
        in: path
        description: Name given to a list.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                description: Items data for update.<br>Can't be less than 1 and more than 128 items.<br>New item IDs are not allowed.<br>Items without existing ids in are not allowed<br>If value of a field explicitly passed as NULL, it will delete a current value of the field.
            examples:
              Request example:
                summary: Request example
                value:
                - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                  field1: new field value
                - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                  field1: new field value
        required: true
      responses:
        '200':
          description: Items updated
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                  - __id: 78f47a5a-b9c4-4802-8bed-e81cf5fde0b4
                    field1: new field value
                    field2: old field value
                  - __id: b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f
                    field1: new field value
                    field2: old field value
                  - __id: 1d543ae8-957d-4fe6-b0f4-ad3ce1eb5bbf
                    field1: field value
        '400':
          description: Bad request:<ul><li>empty body</li><li>no __id fields passed</li><li>fields undefined in the list schema passed</li><li>unexpected type of a field value passed</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: <ul><li>no profile with a given personId</li><li>no custom attribute with a given listName</li><li>no instance of a list with a given listName</li><li>no items with given itemIds in a list</li></ul>
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: 0
                    message: string
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-is-early-access: 'true'
      x-scopes:
      - people:manage
      x-deprecationInformation:
        deprecation: '2023-10-25T00:00:00.000+00:00'
        sunset: '2024-01-25T00:00:00.000+00:00'
        successorOperationId: update-list
      x-throttling-info:
      - type: time
        numberOfRequests: 3
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/contactInformation/push/{pushRegId}:
    get:
      tags:
      - customer-engagement
      summary: Get push device registration
      description: Use this method to get device data
      operationId: get-push-device-registration
      parameters:
      - name: pushRegId
        in: path
        description: Registration identifier of a particular push device registration
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: AppCode
        in: header
        description: Application code
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance'
              examples:
                Response example:
                  summary: Response example
                  value:
                    registrationId: 8621824C-86B2-41F7-BF6F-20D3B1426005
                    applicationId: 753CBCDC1D587223934106E2A2AEDD44
                    isPrimary: false
                    systemData:
                      cloudType: GCM
                      registrationEnabled: true
                      notificationsEnabled: true
                      geofencingSdk: true
                      sdkVersion: 2.0.9.1
                      appVersion: 1.16.0
                      os: Android
                      osVersion: 8.0.0
                      deviceManufacturer: HUAWEI
                      deviceModel: ANE-LX1
                      deviceSecure: true
                      osLanguage: en
                      deviceTimezoneOffset: GMT+03:00
                      deviceName: ANE-LX1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse'
              examples:
                You will get this error response if AppCode header is missing from the request:
                  summary: You will get this error response if AppCode header is missing from the request
                  description: You will get this error response if AppCode header is missing from the request
                  value:
                    errorCode: 48001
                    errorMessage: Application code missing
                Application with supplied application code does not exist:
                  summary: Application with supplied application code does not exist
                  description: Application with supplied application code does not exist
                  value:
                    errorCode: 48012
                    errorMessage: Push application not found
                Registration with supplied pushRegId does not exist:
                  summary: Registration with supplied pushRegId does not exist
                  description: Registration with supplied pushRegId does not exist
                  value:
                    errorCode: 48013
                    errorMessage: Push registration not found
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:read
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - customer-engagement
      summary: Update push device registration
      description: Use this method to update device data
      operationId: update-push-device-registration
      parameters:
      - name: pushRegId
        in: path
        description: Registration identifier of a particular push device registration
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: AppCode
        in: header
        description: Application code
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Partial instance model
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance'
            examples:
              Change mutable standard properties and additional properties:
                summary: Change mutable standard properties and additional properties
                description: Change mutable standard properties and additional properties
                value:
                  isPrimary: true
                  systemData:
                    registrationEnabled: true
                  additionalData:
                    discountApplied: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance'
              examples:
                Response example:
                  summary: Response example
                  value:
                    registrationId: 8621824C-86B2-41F7-BF6F-20D3B1426005
                    applicationId: 753CBCDC1D587223934106E2A2AEDD44
                    isPrimary: false
                    systemData:
                      cloudType: GCM
                      registrationEnabled: true
                      notificationsEnabled: true
                      geofencingSdk: true
                      sdkVersion: 2.0.9.1
                      appVersion: 1.16.0
                      os: Android
                      osVersion: 8.0.0
                      deviceManufacturer: HUAWEI
                      deviceModel: ANE-LX1
                      deviceSecure: true
                      osLanguage: en
                      deviceTimezoneOffset: GMT+03:00
                      deviceName: ANE-LX1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse'
              examples:
                You will get this error response if AppCode header is missing from the request:
                  summary: You will get this error response if AppCode header is missing from the request
                  description: You will get this error response if AppCode header is missing from the request
                  value:
                    errorCode: 48001
                    errorMessage: Application code missing
                Application with supplied application code does not exist:
                  summary: Application with supplied application code does not exist
                  description: Application with supplied application code does not exist
                  value:
                    errorCode: 48012
                    errorMessage: Push application not found
                Registration with supplied pushRegId does not exist:
                  summary: Registration with supplied pushRegId does not exist
                  description: Registration with supplied pushRegId does not exist
                  value:
                    errorCode: 48013
                    errorMessage: Push registration not found
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/contactInformation/push/{pushRegId}/depersonalize:
    post:
      tags:
      - customer-engagement
      summary: Depersonalize push instance
      description: You can depersonalize a device to detach it from a current person profile so that the device won’t receive messages when targeted by any of the person attributes
      operationId: depersonalize-push-instance
      parameters:
      - name: pushRegId
        in: path
        description: Registration identifier of a particular push device registration
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: AppCode
        in: header
        description: Application code
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content: {}
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse'
              examples:
                You will get this error response if AppCode header is missing from the request:
                  summary: You will get this error response if AppCode header is missing from the request
                  description: You will get this error response if AppCode header is missing from the request
                  value:
                    errorCode: 48001
                    errorMessage: Application code missing
                Application with supplied application code does not exist:
                  summary: Application with supplied application code does not exist
                  description: Application with supplied application code does not exist
                  value:
                    errorCode: 48012
                    errorMessage: Push application not found
                Registration with supplied pushRegId does not exist:
                  summary: Registration with supplied pushRegId does not exist
                  description: Registration with supplied pushRegId does not exist
                  value:
                    errorCode: 48013
                    errorMessage: Push registration not found
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /people/2/contactInformation/push/{pushRegId}/personalize:
    post:
      tags:
      - customer-engagement
      summary: Personalize push instance
      description: Each person can have Phone numbers, Emails or External ID. These fields are unique identifiers of a person on Infobip platform and provide a capability to personalize any push device registration with a person profile. The platform provides data grouping functions based on these parameters. For example, if two devices will try to save the same Phone number, then both of them will be collected under a single person. Phone number, Email and External ID are also widely used when targeting users with messages across different channels via Infobip platform.
      operationId: personalize-push-instance
      parameters:
      - name: forceDepersonalize
        in: query
        description: You can set this parameter to true if you want previous personalization to be always reset. Do not use this parameter if you want to know when there’s an attempt to personalize already personalized registration.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: keepAsLead
        in: query
        description: You can set this parameter to true if you want to prevent the promotion from Lead to Customer. Only for specific use cases where the default behaviour wants to be avoided.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: returnPush
        in: query
        description: You can set this parameter to true if you want the response to include "push" mobile app contact information for the person.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: setDeviceAsPrimary
        in: query
        description: You can set this parameter to true if you want to set the device associated with the "pushRegId" as primary device for the person.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: pushRegId
        in: path
        description: Registration identifier of a particular push device registration
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: AppCode
        in: header
        description: Application code
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Partial instance model
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserPersonalizationRequest'
            examples:
              Sample personalization request with tags and custom attributes update:
                summary: Sample personalization request with tags and custom attributes update
                description: Sample personalization request with tags and custom attributes update
                value:
                  identity:
                    externalId: external-user-id
                  attributes:
                    tags:
                    - Personalized
                    customAttributes:
                      personalizationCompleted: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserPersonalizationResponse'
              examples:
                Sample personalization response:
                  summary: Sample personalization response
                  description: Sample personalization response
                  value:
                    externalId: external-user-id
                    customAttributes:
                      personalizationCompleted: true
                    tags:
                    - Personalized
                    contactInformation:
                      phones:
                      - number: '79810000000'
                      emails:
                      - address: my.email@gmail.com
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse'
              examples:
                You will get this error response if AppCode header is missing from the request:
                  summary: You will get this error response if AppCode header is missing from the request
                  description: You will get this error response if AppCode header is missing from the request
                  value:
                    errorCode: 48001
                    errorMessage: Application code missing
                Application with supplied application code does not exist:
                  summary: Application with supplied application code does not exist
                  description: Application with supplied application code does not exist
                  value:
                    errorCode: 48012
                    errorMessage: Push application not found
                Registration with supplied pushRegId does not exist:
                  summary: Registration with supplied pushRegId does not exist
                  description: Registration with supplied pushRegId does not exist
                  value:
                    errorCode: 48013
                    errorMessage: Push registration not found
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /people/3/events:
    post:
      tags:
      - customer-engagement
      summary: Batch Send Events
      description: 'Use this endpoint to batch import People events, including historical events that occurred up to `30` days ago. Batch items must reference an existing person profile and predefined [event type](https://portal.infobip.com/people/events/definitions). You can send up to `5000` events in a single batch. Each individual item within a batch must not exceed `512,000` bytes. The entire batch, which includes all items combined, must not exceed `15,728,640` bytes.<br>Each event in the batch must reference an existing person profile and a predefined event type. If an event references a person identifier that does not match any existing profile, a new `CUSTOMER` profile will automatically be created for that identifier. <br>**Note**: The entire batch will fail to import if any single event fails due to missing event type, properties, etc.'
      operationId: send-custom-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest'
            examples:
              Request example:
                summary: Request example
                value:
                - definitionId: addToCart
                  occurredTime: '2025-03-17T13:00:27.864Z'
                  identifier:
                    id: example@gmail.com
                    type: EMAIL
                    sender: '75320'
                  properties:
                    transactionId: my-transaction-1
                    fromPromoCampaign: true
                    totalCost: 100
                    itemsInCart:
                    - itemId: 1
                      price: 25
                      quantity: 3
                      inStockSince: '2023-11-17T15:47:50.413Z'
                      category: clothes
                    - itemId: 2
                      price: 25
                      quantity: 1
                      inStockSince: '2023-12-17T15:47:50.413Z'
                      category: shoes
                - definitionId: addToCart
                  occurredTime: '2025-03-17T11:30:00.109Z'
                  identifier:
                    id: '15'
                    type: ID
                  properties:
                    transactionId: my-transaction-2
                    fromPromoCampaign: false
                    totalCost: 1539
                    itemsInCart:
                    - itemId: 7
                      price: 39
                      quantity: 1
                      inStockSince: '2024-09-21T10:12:50.209Z'
                      category: shirt
                    - itemId: 8
                      price: 250
                      quantity: 6
                      inStockSince: '2024-09-20T09:21:30.483Z'
                      category: jacket
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest'
            examples:
              Request example:
                summary: Request example
                value:
                - definitionId: addToCart
                  occurredTime: '2025-03-17T13:00:27.864Z'
                  identifier:
                    id: example@gmail.com
                    type: EMAIL
                    sender: '75320'
                  properties:
                    transactionId: my-transaction-1
                    fromPromoCampaign: true
                    totalCost: 100
                    itemsInCart:
                    - itemId: 1
                      price: 25
                      quantity: 3
                      inStockSince: '2023-11-17T15:47:50.413Z'
                      category: clothes
                    - itemId: 2
                      price: 25
                      quantity: 1
                      inStockSince: '2023-12-17T15:47:50.413Z'
                      category: shoes
                - definitionId: addToCart
                  occurredTime: '2025-03-17T11:30:00.109Z'
                  identifier:
                    id: '15'
                    type: ID
                  properties:
                    transactionId: my-transaction-2
                    fromPromoCampaign: false
                    totalCost: 1539
                    itemsInCart:
                    - itemId: 7
                      price: 39
                      quantity: 1
                      inStockSince: '2024-09-21T10:12:50.209Z'
                      category: shirt
                    - itemId: 8
                      price: 250
                      quantity: 6
                      inStockSince: '2024-09-20T09:21:30.483Z'
                      category: jacket
          text/json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest'
            examples:
              Request example:
                summary: Request example
                value:
                - definitionId: addToCart
                  occurredTime: '2025-03-17T13:00:27.864Z'
                  identifier:
                    id: example@gmail.com
                    type: EMAIL
                    sender: '75320'
                  properties:
                    transactionId: my-transaction-1
                    fromPromoCampaign: true
                    totalCost: 100
                    itemsInCart:
                    - itemId: 1
                      price: 25
                      quantity: 3
                      inStockSince: '2023-11-17T15:47:50.413Z'
                      category: clothes
                    - itemId: 2
                      price: 25
                      quantity: 1
                      inStockSince: '2023-12-17T15:47:50.413Z'
                      category: shoes
                - definitionId: addToCart
                  occurredTime: '2025-03-17T11:30:00.109Z'
                  identifier:
                    id: '15'
                    type: ID
                  properties:
                    transactionId: my-transaction-2
                    fromPromoCampaign: false
                    totalCost: 1539
                    itemsInCart:
                    - itemId: 7
                      price: 39
                      quantity: 1
                      inStockSince: '2024-09-21T10:12:50.209Z'
                      category: shirt
                    - itemId: 8
                      price: 250
                      quantity: 6
                      inStockSince: '2024-09-20T09:21:30.483Z'
                      category: jacket
          application/*+json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest'
            examples:
              Request example:
                summary: Request example
                value:
                - definitionId: addToCart
                  occurredTime: '2025-03-17T13:00:27.864Z'
                  identifier:
                    id: example@gmail.com
                    type: EMAIL
                    sender: '75320'
                  properties:
                    transactionId: my-transaction-1
                    fromPromoCampaign: true
                    totalCost: 100
                    itemsInCart:
                    - itemId: 1
                      price: 25
                      quantity: 3
                      inStockSince: '2023-11-17T15:47:50.413Z'
                      category: clothes
                    - itemId: 2
                      price: 25
                      quantity: 1
                      inStockSince: '2023-12-17T15:47:50.413Z'
                      category: shoes
                - definitionId: addToCart
                  occurredTime: '2025-03-17T11:30:00.109Z'
                  identifier:
                    id: '15'
                    type: ID
                  properties:
                    transactionId: my-transaction-2
                    fromPromoCampaign: false
                    totalCost: 1539
                    itemsInCart:
                    - itemId: 7
                      price: 39
                      quantity: 1
                      inStockSince: '2024-09-21T10:12:50.209Z'
                      category: shirt
                    - itemId: 8
                      price: 250
                      quantity: 6
                      inStockSince: '2024-09-20T09:21:30.483Z'
                      category: jacket
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse'
              examples:
                Invalid JSON request body:
                  summary: Invalid JSON request body
                  description: Occurs when the request body is either missing, null, or not properly structured as a JSON array, preventing successful processing of the request.
                  value:
                    errors:
                    - index: -1
                      code: 400500
                      message: Invalid request. Please ensure the request body is a properly structured JSON array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Invalid schema error:
                  summary: Invalid schema error
                  description: Occurs when an event in the batch has a missing or incorrect schema definition. This can happen if the event's definition ID is not recognized, or if the properties do not match the expected schema, such as having redundant properties or incorrect types.
                  value:
                    errors:
                    - index: -1
                      code: 400501
                      message: 'The event schema is invalid. Please ensure each event has a valid definition ID and properties match the expected schema. Details: <specific_error_message>.'
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Empty batch error:
                  summary: Empty batch error
                  description: Occurs when the request body contains an empty array for the batch, which is required to have at least one item for processing.
                  value:
                    errors:
                    - index: -1
                      code: 400502
                      message: The batch cannot be empty. Please provide at least one item in the request array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Batch count exceeded:
                  summary: Batch count exceeded
                  description: Occurs when the number of items in the batch exceeds the maximum allowed limit, preventing successful processing of the request.
                  value:
                    errors:
                    - index: -1
                      code: 400503
                      message: The batch count exceeds the allowed limit of <allowed_limit> items. Please reduce the number of items in the request array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Invalid batch item error:
                  summary: Invalid batch item error
                  description: Occurs when one or more properties of an event in the batch fail validation checks. This can include issues such as incorrect formats, values outside allowed ranges, or missing required properties.
                  value:
                    errors:
                    - index: 0
                      code: 400504
                      message: One or more batch items contain invalid properties. Please review the details for specific validation errors.
                      details:
                      - property: eventId
                        message: Must only include letters (A-Z, a-z), digits (0-9), underscores (_), and hyphens (-).
                      - property: identifier.id
                        message: Must not be empty.
                    - index: 4
                      code: 400504
                      message: One or more batch items contain invalid properties. Please review the details for specific validation errors.
                      details:
                      - property: identifier.type
                        message: 'Must be one of the following types: <allowed_types>.'
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Person not found error:
                  summary: Person not found error
                  description: Occurs when the system is unable to locate a person using the provided identifier in the event. This prevents the event from being processed as the target person cannot be identified.
                  value:
                    errors:
                    - index: 0
                      code: 400505
                      message: Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system.
                    - index: 4
                      code: 400505
                      message: Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Internal event posting prohibition:
                  summary: Internal event posting prohibition
                  description: Occurs when attempting to post an internal event.
                  value:
                    errors:
                    - index: 0
                      code: 400506
                      message: Internal events posting prohibited. Please ensure that only custom event definitions are used.
                    - index: 4
                      code: 400506
                      message: Internal events posting prohibited. Please ensure that only custom event definitions are used.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse'
              examples:
                Invalid JSON request body:
                  summary: Invalid JSON request body
                  description: Occurs when the request body is either missing, null, or not properly structured as a JSON array, preventing successful processing of the request.
                  value:
                    errors:
                    - index: -1
                      code: 400500
                      message: Invalid request. Please ensure the request body is a properly structured JSON array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Invalid schema error:
                  summary: Invalid schema error
                  description: Occurs when an event in the batch has a missing or incorrect schema definition. This can happen if the event's definition ID is not recognized, or if the properties do not match the expected schema, such as having redundant properties or incorrect types.
                  value:
                    errors:
                    - index: -1
                      code: 400501
                      message: 'The event schema is invalid. Please ensure each event has a valid definition ID and properties match the expected schema. Details: <specific_error_message>.'
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Empty batch error:
                  summary: Empty batch error
                  description: Occurs when the request body contains an empty array for the batch, which is required to have at least one item for processing.
                  value:
                    errors:
                    - index: -1
                      code: 400502
                      message: The batch cannot be empty. Please provide at least one item in the request array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Batch count exceeded:
                  summary: Batch count exceeded
                  description: Occurs when the number of items in the batch exceeds the maximum allowed limit, preventing successful processing of the request.
                  value:
                    errors:
                    - index: -1
                      code: 400503
                      message: The batch count exceeds the allowed limit of <allowed_limit> items. Please reduce the number of items in the request array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Invalid batch item error:
                  summary: Invalid batch item error
                  description: Occurs when one or more properties of an event in the batch fail validation checks. This can include issues such as incorrect formats, values outside allowed ranges, or missing required properties.
                  value:
                    errors:
                    - index: 0
                      code: 400504
                      message: One or more batch items contain invalid properties. Please review the details for specific validation errors.
                      details:
                      - property: eventId
                        message: Must only include letters (A-Z, a-z), digits (0-9), underscores (_), and hyphens (-).
                      - property: identifier.id
                        message: Must not be empty.
                    - index: 4
                      code: 400504
                      message: One or more batch items contain invalid properties. Please review the details for specific validation errors.
                      details:
                      - property: identifier.type
                        message: 'Must be one of the following types: <allowed_types>.'
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Person not found error:
                  summary: Person not found error
                  description: Occurs when the system is unable to locate a person using the provided identifier in the event. This prevents the event from being processed as the target person cannot be identified.
                  value:
                    errors:
                    - index: 0
                      code: 400505
                      message: Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system.
                    - index: 4
                      code: 400505
                      message: Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Internal event posting prohibition:
                  summary: Internal event posting prohibition
                  description: Occurs when attempting to post an internal event.
                  value:
                    errors:
                    - index: 0
                      code: 400506
                      message: Internal events posting prohibited. Please ensure that only custom event definitions are used.
                    - index: 4
                      code: 400506
                      message: Internal events posting prohibited. Please ensure that only custom event definitions are used.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
            text/json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse'
              examples:
                Invalid JSON request body:
                  summary: Invalid JSON request body
                  description: Occurs when the request body is either missing, null, or not properly structured as a JSON array, preventing successful processing of the request.
                  value:
                    errors:
                    - index: -1
                      code: 400500
                      message: Invalid request. Please ensure the request body is a properly structured JSON array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Invalid schema error:
                  summary: Invalid schema error
                  description: Occurs when an event in the batch has a missing or incorrect schema definition. This can happen if the event's definition ID is not recognized, or if the properties do not match the expected schema, such as having redundant properties or incorrect types.
                  value:
                    errors:
                    - index: -1
                      code: 400501
                      message: 'The event schema is invalid. Please ensure each event has a valid definition ID and properties match the expected schema. Details: <specific_error_message>.'
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Empty batch error:
                  summary: Empty batch error
                  description: Occurs when the request body contains an empty array for the batch, which is required to have at least one item for processing.
                  value:
                    errors:
                    - index: -1
                      code: 400502
                      message: The batch cannot be empty. Please provide at least one item in the request array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Batch count exceeded:
                  summary: Batch count exceeded
                  description: Occurs when the number of items in the batch exceeds the maximum allowed limit, preventing successful processing of the request.
                  value:
                    errors:
                    - index: -1
                      code: 400503
                      message: The batch count exceeds the allowed limit of <allowed_limit> items. Please reduce the number of items in the request array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Invalid batch item error:
                  summary: Invalid batch item error
                  description: Occurs when one or more properties of an event in the batch fail validation checks. This can include issues such as incorrect formats, values outside allowed ranges, or missing required properties.
                  value:
                    errors:
                    - index: 0
                      code: 400504
                      message: One or more batch items contain invalid properties. Please review the details for specific validation errors.
                      details:
                      - property: eventId
                        message: Must only include letters (A-Z, a-z), digits (0-9), underscores (_), and hyphens (-).
                      - property: identifier.id
                        message: Must not be empty.
                    - index: 4
                      code: 400504
                      message: One or more batch items contain invalid properties. Please review the details for specific validation errors.
                      details:
                      - property: identifier.type
                        message: 'Must be one of the following types: <allowed_types>.'
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Person not found error:
                  summary: Person not found error
                  description: Occurs when the system is unable to locate a person using the provided identifier in the event. This prevents the event from being processed as the target person cannot be identified.
                  value:
                    errors:
                    - index: 0
                      code: 400505
                      message: Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system.
                    - index: 4
                      code: 400505
                      message: Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Internal event posting prohibition:
                  summary: Internal event posting prohibition
                  description: Occurs when attempting to post an internal event.
                  value:
                    errors:
                    - index: 0
                      code: 400506
                      message: Internal events posting prohibited. Please ensure that only custom event definitions are used.
                    - index: 4
                      code: 400506
                      message: Internal events posting prohibited. Please ensure that only custom event definitions are used.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
            application/*+json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse'
              examples:
                Invalid JSON request body:
                  summary: Invalid JSON request body
                  description: Occurs when the request body is either missing, null, or not properly structured as a JSON array, preventing successful processing of the request.
                  value:
                    errors:
                    - index: -1
                      code: 400500
                      message: Invalid request. Please ensure the request body is a properly structured JSON array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Invalid schema error:
                  summary: Invalid schema error
                  description: Occurs when an event in the batch has a missing or incorrect schema definition. This can happen if the event's definition ID is not recognized, or if the properties do not match the expected schema, such as having redundant properties or incorrect types.
                  value:
                    errors:
                    - index: -1
                      code: 400501
                      message: 'The event schema is invalid. Please ensure each event has a valid definition ID and properties match the expected schema. Details: <specific_error_message>.'
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Empty batch error:
                  summary: Empty batch error
                  description: Occurs when the request body contains an empty array for the batch, which is required to have at least one item for processing.
                  value:
                    errors:
                    - index: -1
                      code: 400502
                      message: The batch cannot be empty. Please provide at least one item in the request array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Batch count exceeded:
                  summary: Batch count exceeded
                  description: Occurs when the number of items in the batch exceeds the maximum allowed limit, preventing successful processing of the request.
                  value:
                    errors:
                    - index: -1
                      code: 400503
                      message: The batch count exceeds the allowed limit of <allowed_limit> items. Please reduce the number of items in the request array.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Invalid batch item error:
                  summary: Invalid batch item error
                  description: Occurs when one or more properties of an event in the batch fail validation checks. This can include issues such as incorrect formats, values outside allowed ranges, or missing required properties.
                  value:
                    errors:
                    - index: 0
                      code: 400504
                      message: One or more batch items contain invalid properties. Please review the details for specific validation errors.
                      details:
                      - property: eventId
                        message: Must only include letters (A-Z, a-z), digits (0-9), underscores (_), and hyphens (-).
                      - property: identifier.id
                        message: Must not be empty.
                    - index: 4
                      code: 400504
                      message: One or more batch items contain invalid properties. Please review the details for specific validation errors.
                      details:
                      - property: identifier.type
                        message: 'Must be one of the following types: <allowed_types>.'
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Person not found error:
                  summary: Person not found error
                  description: Occurs when the system is unable to locate a person using the provided identifier in the event. This prevents the event from being processed as the target person cannot be identified.
                  value:
                    errors:
                    - index: 0
                      code: 400505
                      message: Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system.
                    - index: 4
                      code: 400505
                      message: Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
                Internal event posting prohibition:
                  summary: Internal event posting prohibition
                  description: Occurs when attempting to post an internal event.
                  value:
                    errors:
                    - index: 0
                      code: 400506
                      message: Internal events posting prohibited. Please ensure that only custom event definitions are used.
                    - index: 4
                      code: 400506
                      message: Internal events posting prohibited. Please ensure that only custom event definitions are used.
                    traceId: <trace_id>
                    type: https://tools.ietf.org/html/rfc9110#section-15.5.1
                    title: One or more validation errors occurred.
                    status: 400
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:use
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /peopleevents/2/persons/{personId}/definitions/{definitionId}/events:
    post:
      tags:
      - customer-engagement
      summary: Send Event
      description: Use this endpoint to track events that persons perform. Your request must refer to existing person profile and [event definition](https://portal.infobip.com/people/events/definitions).
      operationId: send-custom-event
      parameters:
      - name: definitionId
        in: path
        description: Identifier of the custom event definition. Event properties are passed in the request body.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: personId
        in: path
        description: Identifier of the person who performed the event. The `identifierType` query parameter specifies the type of the ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: identifierType
        in: query
        description: Person's identifier type.
        required: true
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.PersonUniqueFieldType'
      - name: createPerson
        in: query
        description: 'Set this parameter to `true` to automatically create a person profile with the specified `personId` and `identifierType` if no existing profile matches the provided identifier. The default value is `false`.<br>**Note**: New profiles can only be created for the following identifier types: `PHONE`, `EMAIL`, or `EXTERNAL_ID`.'
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  properties:
                    transactionId: my-transaction-1
                    fromPromoCampaign: true
                    totalCost: 100
                    itemsInCart:
                    - itemId: 1
                      price: 25
                      quantity: 3
                      inStockSince: '2023-11-17T15:47:50.4136517Z'
                      category: clothes
                    - itemId: 2
                      price: 25
                      quantity: 1
                      inStockSince: '2023-12-17T15:47:50.4138054Z'
                      category: shoes
          application/json:
            schema:
              $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  properties:
                    transactionId: my-transaction-1
                    fromPromoCampaign: true
                    totalCost: 100
                    itemsInCart:
                    - itemId: 1
                      price: 25
                      quantity: 3
                      inStockSince: '2023-11-17T15:47:50.4136517Z'
                      category: clothes
                    - itemId: 2
                      price: 25
                      quantity: 1
                      inStockSince: '2023-12-17T15:47:50.4138054Z'
                      category: shoes
          text/json:
            schema:
              $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  properties:
                    transactionId: my-transaction-1
                    fromPromoCampaign: true
                    totalCost: 100
                    itemsInCart:
                    - itemId: 1
                      price: 25
                      quantity: 3
                      inStockSince: '2023-11-17T15:47:50.4136517Z'
                      category: clothes
                    - itemId: 2
                      price: 25
                      quantity: 1
                      inStockSince: '2023-12-17T15:47:50.4138054Z'
                      category: shoes
          application/*+json:
            schema:
              $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  properties:
                    transactionId: my-transaction-1
                    fromPromoCampaign: true
                    totalCost: 100
                    itemsInCart:
                    - itemId: 1
                      price: 25
                      quantity: 3
                      inStockSince: '2023-11-17T15:47:50.4136517Z'
                      category: clothes
                    - itemId: 2
                      price: 25
                      quantity: 1
                      inStockSince: '2023-12-17T15:47:50.4138054Z'
                      category: shoes
      responses:
        '201':
          description: Successfully created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    eventId: EFDB662A-F0BD-4064-8F49-16C0C1C48AD2
                    definitionId: addToCart
                    occurredTime: '2024-05-17T15:47:50.4139152Z'
                    properties:
                      transactionId: my-transaction-1
                      fromPromoCampaign: true
                      totalCost: 100
                      itemsInCart:
                      - itemId: 1
                        price: 25
                        quantity: 3
                        inStockSince: '2023-11-17T15:47:50.4136517Z'
                        category: clothes
                      - itemId: 2
                        price: 25
                        quantity: 1
                        inStockSince: '2023-12-17T15:47:50.4138054Z'
                        category: shoes
                    metadata:
                      source: API
            application/json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    eventId: EFDB662A-F0BD-4064-8F49-16C0C1C48AD2
                    definitionId: addToCart
                    occurredTime: '2024-05-17T15:47:50.4139152Z'
                    properties:
                      transactionId: my-transaction-1
                      fromPromoCampaign: true
                      totalCost: 100
                      itemsInCart:
                      - itemId: 1
                        price: 25
                        quantity: 3
                        inStockSince: '2023-11-17T15:47:50.4136517Z'
                        category: clothes
                      - itemId: 2
                        price: 25
                        quantity: 1
                        inStockSince: '2023-12-17T15:47:50.4138054Z'
                        category: shoes
                    metadata:
                      source: API
            text/json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    eventId: EFDB662A-F0BD-4064-8F49-16C0C1C48AD2
                    definitionId: addToCart
                    occurredTime: '2024-05-17T15:47:50.4139152Z'
                    properties:
                      transactionId: my-transaction-1
                      fromPromoCampaign: true
                      totalCost: 100
                      itemsInCart:
                      - itemId: 1
                        price: 25
                        quantity: 3
                        inStockSince: '2023-11-17T15:47:50.4136517Z'
                        category: clothes
                      - itemId: 2
                        price: 25
                        quantity: 1
                        inStockSince: '2023-12-17T15:47:50.4138054Z'
                        category: shoes
                    metadata:
                      source: API
        '400':
          description: Invalid resource representation
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:use
      - web:sdk
      x-throttling-info:
      - type: time
        numberOfRequests: 250
        numberOfTimeUnits: 0
        timeUnit: s
  /peopleevents/2/definitions:
    get:
      tags:
      - customer-engagement
      summary: List Event Definitions
      description: Retrieve a paginated list of event definitions, including standard, custom, and template definitions. Use query parameters to filter by category (`External`, `Person`, `Channel`, `Product`, `Template`) or search by definition ID, title, or description. Results can be ordered by definition ID or title.
      operationId: list-event-definitions
      parameters:
      - name: offset
        in: query
        description: A pagination parameter that specifies the number of records to skip before starting to return results.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          maximum: 2147483647
          minimum: 0
      - name: limit
        in: query
        description: A pagination parameter that specifies the maximum number of records to return in a single response.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          maximum: 2147483647
          minimum: 0
      - name: orderType
        in: query
        description: 'Defines the sort direction for the results.<br>**Note**: If `orderField` is not provided, this parameter will not have any effect.'
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderDirection'
      - name: orderField
        in: query
        description: 'Specifies the field by which the results should be ordered.<br>**Note**: If `orderType` is not provided, ordering will not work.'
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderField'
      - name: category
        in: query
        description: Filters results by one or more event definition categories.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionCategory'
          uniqueItems: true
      - name: searchText
        in: query
        description: Text used for searching event definitions by definition ID, title, or description.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
                  - isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
                  - isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
                  - isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
                  - isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: No matches
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:read
    post:
      tags:
      - customer-engagement
      summary: Create Event Definition
      description: Create a new custom event definition either from scratch or from a template. When creating from scratch, specify a unique definition ID (alphanumeric only, max `36` characters), title, description, and up to `120` fields. When using a template, only provide the template ID and optional additional fields—the title, description, and default fields are inherited from the template. Supports various field types including `String`, `Boolean`, `DateTime`, `Numeric`, `Decimal`, and `List` (with nested object schema).
      operationId: create-event-definition
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource'
            examples:
              Request example:
                summary: Request example
                value:
                  definitionId: addToCart
                  title: Item added to cart
                  description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                  fields:
                  - name: transactionId
                    type: String
                  - name: fromPromoCampaign
                    type: Boolean
                  - name: totalCost
                    type: Decimal
                  - name: itemsInCart
                    type: List
                    schema:
                      type: Object
                      fields:
                      - name: itemId
                        type: Decimal
                      - name: price
                        type: Decimal
                      - name: quantity
                        type: Decimal
                      - name: inStockSince
                        type: DateTime
                      - name: category
                        type: String
          application/json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource'
            examples:
              Request example:
                summary: Request example
                value:
                  definitionId: addToCart
                  title: Item added to cart
                  description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                  fields:
                  - name: transactionId
                    type: String
                  - name: fromPromoCampaign
                    type: Boolean
                  - name: totalCost
                    type: Decimal
                  - name: itemsInCart
                    type: List
                    schema:
                      type: Object
                      fields:
                      - name: itemId
                        type: Decimal
                      - name: price
                        type: Decimal
                      - name: quantity
                        type: Decimal
                      - name: inStockSince
                        type: DateTime
                      - name: category
                        type: String
          text/json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource'
            examples:
              Request example:
                summary: Request example
                value:
                  definitionId: addToCart
                  title: Item added to cart
                  description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                  fields:
                  - name: transactionId
                    type: String
                  - name: fromPromoCampaign
                    type: Boolean
                  - name: totalCost
                    type: Decimal
                  - name: itemsInCart
                    type: List
                    schema:
                      type: Object
                      fields:
                      - name: itemId
                        type: Decimal
                      - name: price
                        type: Decimal
                      - name: quantity
                        type: Decimal
                      - name: inStockSince
                        type: DateTime
                      - name: category
                        type: String
          application/*+json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource'
            examples:
              Request example:
                summary: Request example
                value:
                  definitionId: addToCart
                  title: Item added to cart
                  description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                  fields:
                  - name: transactionId
                    type: String
                  - name: fromPromoCampaign
                    type: Boolean
                  - name: totalCost
                    type: Decimal
                  - name: itemsInCart
                    type: List
                    schema:
                      type: Object
                      fields:
                      - name: itemId
                        type: Decimal
                      - name: price
                        type: Decimal
                      - name: quantity
                        type: Decimal
                      - name: inStockSince
                        type: DateTime
                      - name: category
                        type: String
        required: true
      responses:
        '201':
          description: Successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource'
              examples:
                Response example:
                  summary: Response example
                  value:
                    isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
            text/json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource'
              examples:
                Response example:
                  summary: Response example
                  value:
                    isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
        '400':
          description: Invalid resource representation
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '409':
          description: Conflict. Definition with such 'definitionId' has already existed.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
  /peopleevents/2/definitions/{definitionId}:
    get:
      tags:
      - customer-engagement
      summary: Get Event Definition
      description: Retrieve complete details of a specific event definition, including its fields, data types, category, and whether it's a standard or custom definition. Useful for understanding the schema before sending events or for validating your event data structure.
      operationId: get-event-definition
      parameters:
      - name: definitionId
        in: path
        description: Event definition identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource'
              examples:
                Response example:
                  summary: Response example
                  value:
                    isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
            text/json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource'
              examples:
                Response example:
                  summary: Response example
                  value:
                    isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: No matches
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:read
    post:
      tags:
      - customer-engagement
      summary: Update Event Definition
      description: Update an existing custom event definition by adding new fields or modifying the title and description. Only supports additive changes—you can add new fields but **cannot** remove existing fields or change their types. This ensures backward compatibility with historical events. Standard (internal) definitions and template-inherited properties cannot be modified.
      operationId: update-event-definition
      parameters:
      - name: definitionId
        in: path
        description: Event definition identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource'
            examples:
              Request example:
                summary: Request example
                value:
                  title: Item added to cart
                  description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                  fields:
                  - name: transactionId
                    type: String
                  - name: fromPromoCampaign
                    type: Boolean
                  - name: totalCost
                    type: Decimal
                  - name: itemsInCart
                    type: List
                    schema:
                      type: Object
                      fields:
                      - name: itemId
                        type: Decimal
                      - name: price
                        type: Decimal
                      - name: quantity
                        type: Decimal
                      - name: inStockSince
                        type: DateTime
                      - name: category
                        type: String
          application/json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource'
            examples:
              Request example:
                summary: Request example
                value:
                  title: Item added to cart
                  description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                  fields:
                  - name: transactionId
                    type: String
                  - name: fromPromoCampaign
                    type: Boolean
                  - name: totalCost
                    type: Decimal
                  - name: itemsInCart
                    type: List
                    schema:
                      type: Object
                      fields:
                      - name: itemId
                        type: Decimal
                      - name: price
                        type: Decimal
                      - name: quantity
                        type: Decimal
                      - name: inStockSince
                        type: DateTime
                      - name: category
                        type: String
          text/json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource'
            examples:
              Request example:
                summary: Request example
                value:
                  title: Item added to cart
                  description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                  fields:
                  - name: transactionId
                    type: String
                  - name: fromPromoCampaign
                    type: Boolean
                  - name: totalCost
                    type: Decimal
                  - name: itemsInCart
                    type: List
                    schema:
                      type: Object
                      fields:
                      - name: itemId
                        type: Decimal
                      - name: price
                        type: Decimal
                      - name: quantity
                        type: Decimal
                      - name: inStockSince
                        type: DateTime
                      - name: category
                        type: String
          application/*+json:
            schema:
              $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource'
            examples:
              Request example:
                summary: Request example
                value:
                  title: Item added to cart
                  description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                  fields:
                  - name: transactionId
                    type: String
                  - name: fromPromoCampaign
                    type: Boolean
                  - name: totalCost
                    type: Decimal
                  - name: itemsInCart
                    type: List
                    schema:
                      type: Object
                      fields:
                      - name: itemId
                        type: Decimal
                      - name: price
                        type: Decimal
                      - name: quantity
                        type: Decimal
                      - name: inStockSince
                        type: DateTime
                      - name: category
                        type: String
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource'
              examples:
                Response example:
                  summary: Response example
                  value:
                    isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
            text/json:
              schema:
                $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource'
              examples:
                Response example:
                  summary: Response example
                  value:
                    isInternalDefinition: false
                    category: external
                    definitionId: addToCart
                    title: Item added to cart
                    description: Occurs when customer adds item to cart, without checkout. Carries information about items added
                    fields:
                    - name: transactionId
                      type: String
                    - name: fromPromoCampaign
                      type: Boolean
                    - name: totalCost
                      type: Decimal
                    - name: itemsInCart
                      type: List
                      schema:
                        type: Object
                        fields:
                        - name: itemId
                          type: Decimal
                        - name: price
                          type: Decimal
                        - name: quantity
                          type: Decimal
                        - name: inStockSince
                          type: DateTime
                        - name: category
                          type: String
        '400':
          description: Invalid resource representation
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: No matches
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
  /peopleevents/1/export:
    post:
      tags:
      - customer-engagement
      summary: Submit event export request
      description: "Events export allows you to asynchronously export People Events data to a compressed file or multiple files in your AWS S3 bucket.\n\nRefer to [product documentation](https://www.infobip.com/docs/people/events#events-in-external-systems) for detailed information on configuring AWS S3 for export, export file format and event data schema. \n\n**Throttling**\n\nYou can have maximum of 72 hours worth of export requests in progress at one time.\n\n"
      operationId: create-events-export-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/a1a8ff0e2d4e8815c87f131be18d5198cdc635a778df6b963f0f0a4b59822f94.ExportRequestBody'
            examples:
              Export events to an s3 bucket:
                summary: Export events to an s3 bucket
                value:
                  roleArn: arn:aws:iam::account:role/role-name-with-path
                  bucket: exported-events-bucket
                  region: EU_CENTRAL_1
                  startTime: 2022-01-01T00:00:00.000+0000
                  endTime: 2022-01-01T01:00:00.000+0000
              Export events to a directory of an s3 bucket:
                summary: Export events to a directory of an s3 bucket
                value:
                  roleArn: arn:aws:iam::account:role/role-name-with-path
                  bucket: exported-events-bucket
                  region: EU_CENTRAL_1
                  directoryPath: dir/subdir/
                  startTime: 2022-01-01T00:00:00.000+0000
                  endTime: 2022-01-01T01:00:00.000+0000
              Export events with definitionId matching filter:
                summary: Export events with definitionId matching filter
                value:
                  roleArn: arn:aws:iam::account:role/role-name-with-path
                  bucket: exported-events-bucket
                  region: EU_CENTRAL_1
                  startTime: 2022-01-01T00:00:00.000+0000
                  endTime: 2022-01-01T01:00:00.000+0000
                  definitionIdList:
                  - person*Flow
                  - emailOpened
                  - pageView
              Export events enriched with moments information:
                summary: Export events enriched with moments information
                value:
                  roleArn: arn:aws:iam::account:role/role-name-with-path
                  bucket: exported-events-bucket
                  region: EU_CENTRAL_1
                  startTime: 2022-01-01T00:00:00.000+0000
                  endTime: 2022-01-01T01:00:00.000+0000
                  enrichWithMomentsInfo: true
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.ExportResponseBody'
              examples:
                Response for a valid event export request:
                  summary: Response for a valid event export request
                  value:
                    requestId: 4c959f87-9a45-4e16-bcd2-7f2a79e95067
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 5
  /peopleevents/1/export/status/{requestId}:
    get:
      tags:
      - customer-engagement
      summary: Check status of event export request
      description: Retrieves the status of a previously submitted data export request by the request ID.
      operationId: get-events-export-request-status
      parameters:
      - name: requestId
        in: path
        description: Request ID (unique identifier) of a previously submitted data export request.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          writeOnly: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.StatusResponseBody'
              examples:
                Request has been submitted but not processed.:
                  summary: Request has been submitted but not processed.
                  value:
                    requestId: 4c959f87-9a45-4e16-bcd2-7f2a79e95067
                    status: SUBMITTED
                Request is in progress.:
                  summary: Request is in progress.
                  value:
                    requestId: 4c959f87-9a45-4e16-bcd2-7f2a79e95067
                    status: IN_PROGRESS
                Request has been completed successfully.:
                  summary: Request has been completed successfully.
                  value:
                    requestId: 4c959f87-9a45-4e16-bcd2-7f2a79e95067
                    status: COMPLETED_SUCCESSFULLY
                Request is completed with no events exported.:
                  summary: Request is completed with no events exported.
                  value:
                    requestId: 4c959f87-9a45-4e16-bcd2-7f2a79e95067
                    status: COMPLETED_SUCCESSFULLY
                    message: 0 events found for the time period queried.
                There has been an error while processing the request, request is queued to be retried.:
                  summary: There has been an error while processing the request, request is queued to be retried.
                  value:
                    requestId: 4c959f87-9a45-4e16-bcd2-7f2a79e95067
                    status: FAILED_AWAITING_RETRY
                    message: Exception caught while trying to push file to S3.
                Request failed after maximum retries.:
                  summary: Request failed after maximum retries.
                  value:
                    requestId: 4c959f87-9a45-4e16-bcd2-7f2a79e95067
                    status: FAILED_AFTER_MAX_RETRIES
                    message: Exception caught while trying to push file to S3.
                Request is waiting to be cancelled.:
                  summary: Request is waiting to be cancelled.
                  value:
                    requestId: 4c959f87-9a45-4e16-bcd2-7f2a79e95067
                    status: SUBMITTED
                    message: Cancellation pending, cancellation request received at 2022-01-01T00:00:00.000Z
                Request has been cancelled.:
                  summary: Request has been cancelled.
                  value:
                    requestId: 4c959f87-9a45-4e16-bcd2-7f2a79e95067
                    status: CANCELLED_BY_CUSTOMER
                    message: Cancellation complete, cancellation request received at 2022-01-01T00:00:00.000Z
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 5
  /peopleevents/1/export/{requestId}:
    delete:
      tags:
      - customer-engagement
      summary: Asynchronous cancellation of an event export request
      description: Requests asynchronous cancellation of a previously submitted data export request by the request ID.
      operationId: cancel-events-export-request
      parameters:
      - name: requestId
        in: path
        description: Request ID (unique identifier) of a previously submitted data export request.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          writeOnly: true
      responses:
        '202':
          description: Accepted
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 1
  /peopleevents/1/export/definitions:
    get:
      tags:
      - customer-engagement
      summary: Get list of event definitions
      description: "Retrieves a list of all available event definitions, including custom events. \nThe event definitions can be then used as a filter in the \n[Event Export API](https://www.infobip.com/docs/api#customer-engagement/people/create-events-export-request)."
      operationId: get-events-definitions-for-export
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.DefinitionsResponseBody'
              examples:
                Response for getting a list of `definitionId`s:
                  summary: Response for getting a list of `definitionId`s
                  value:
                    definitionIdList:
                    - emailOpened
                    - pageView
                    - personEnteredFlow
                    - customEvent
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 5
  /people/3/segments:
    get:
      tags:
      - customer-engagement
      summary: Get a list of segments
      description: Use this method to get a list of segments.
      externalDocs:
        description: Learn more about Segments and its use cases.
        url: https://www.infobip.com/docs/people/manage-audience#segments
      operationId: get-segments
      parameters:
      - name: page
        in: query
        description: Zero-based page index (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 0
      - name: size
        in: query
        description: The size of the page to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 20
          maximum: 1000
          minimum: 1
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            example: name,DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageSegmentResponseDto'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:read
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Create a segment
      description: Use this method to create a segment.
      externalDocs:
        description: Learn more about Segments and its use cases.
        url: https://www.infobip.com/docs/people/manage-audience#segments
      operationId: create-segment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentCreateDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/3/segments/{segmentId}:
    get:
      tags:
      - customer-engagement
      summary: Get a segment
      description: Use this method to get a segment by ID.
      externalDocs:
        description: Learn more about Segments and its use cases.
        url: https://www.infobip.com/docs/people/manage-audience#segments
      operationId: get-segment
      parameters:
      - name: segmentId
        in: path
        description: A unique segment identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: A unique segment identifier.
          example: 42
        example: 42
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:read
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - customer-engagement
      summary: Update a segment
      description: Use this method to update a segment.
      externalDocs:
        description: Learn more about Segments and its use cases.
        url: https://www.infobip.com/docs/people/manage-audience#segments
      operationId: update-segment
      parameters:
      - name: segmentId
        in: path
        description: A unique segment identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: A unique segment identifier.
          example: 42
        example: 42
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentUpdateDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete a segment
      description: Use this method to delete a segment by ID.
      externalDocs:
        description: Learn more about Segments and its use cases.
        url: https://www.infobip.com/docs/people/manage-audience#segments
      operationId: delete-segment
      parameters:
      - name: segmentId
        in: path
        description: A unique segment identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: A unique segment identifier.
          example: 42
        example: 42
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /people/3/segments/{segmentId}/persons:
    get:
      tags:
      - customer-engagement
      summary: Get persons in a segment
      description: Use this method to get persons in a segment by ID.
      externalDocs:
        description: Learn more about Segments and its use cases.
        url: https://www.infobip.com/docs/people/manage-audience#segments
      operationId: get-segment-persons
      parameters:
      - name: segmentId
        in: path
        description: A unique segment identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: A unique segment identifier.
          example: 42
        example: 42
      - name: page
        in: query
        description: Zero-based page index (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 0
      - name: size
        in: query
        description: The size of the page to be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 20
          maximum: 1000
          minimum: 1
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            example: name,DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PagePersonV3'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - people:read
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /moments/1/flows/{campaignId}/participants:
    post:
      tags:
      - customer-engagement
      summary: Add participants to flow
      description: "Use this endpoint to add participants to a flow, accommodating anywhere from 1 to 1000 persons.\n                When participants are added, their profiles in People are automatically created, updated or merged based on the identifiers provided.<br>\n                If identifiers are unique, a new profile is created.<br>\n                If identifiers match an existing profile, then that profile is updated.<br>\n                If identifiers refer to multiple existing profiles or are not unique within the request, profiles are merged.<br>\n                To prevent unwanted merges, ensure each participant's identifiers\n                (<code>identifyBy</code>, <code>externalId</code> and <code>contactInformation</code>) are unique."
      operationId: add-flow-participants
      parameters:
      - name: campaignId
        in: path
        description: Unique identifier of the flow that participant will be added to.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 200000000000001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantsRequest'
            examples:
              Add participants to Flow:
                summary: Add participants to Flow
                description: Add participants to Flow
                value:
                  participants:
                  - identifyBy:
                      identifier: '370329180020364'
                      type: FACEBOOK
                  - identifyBy:
                      identifier: test@infobip.com
                      type: EMAIL
                    variables:
                      orderNumber: 1167873391
                  - identifyBy:
                      identifier: test2@infobip.com
                      type: EMAIL
                    variables:
                      orderNumber: 1595299041
                    person:
                      externalId: optional_external_person_id
                      customAttributes:
                        Contract Expiry: '2023-04-01'
                        Company: Infobip
                      contactInformation:
                        email:
                        - address: test@infobip.com
                  notifyUrl: https://mydomain/callback
                  callbackData: Callback Data
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantsResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    operationId: 03f2d474-0508-46bf-9f3d-d8e2c28adaea
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.BadRequestResponse'
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    type: about:blank
                    title: Bad Request
                    status: 400
                    detail: Failed to read request
                    instance: /moments/1/flows/200000000000001/participants
                Invalid number of participants:
                  summary: Invalid number of participants
                  description: Invalid number of participants
                  value:
                    errorCode: '400'
                    errorMessage: 'Number of participants must be between 1 and 1000. Received: 1200'
                Mandatory fields absent:
                  summary: Mandatory fields absent
                  description: Mandatory fields absent
                  value:
                    errorCode: '400'
                    errorMessage: 'Mandatory fields are absent: [participants]'
                Validation errors:
                  summary: Validation errors
                  description: Validation errors
                  value:
                    errorCode: '400'
                    errorMessage: Field participants.[0].identifyBy.type must not be null or unsupported value
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: '40401'
                    errorMessage: Could not find active flow for campaign 200000000000001
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a96177a069f927b552e6f478d6833812472502f930c109564e4f89f3264faaa.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - flow:use
      - flow:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /moments/1/flows/{campaignId}/participants/report:
    get:
      tags:
      - customer-engagement
      summary: Get a report on participants added to flow
      description: "Use this API endpoint to fetch a report to confirm that all persons have been successfully added to the flow.\n                Please note that report is stored for 30 days."
      operationId: get-flow-participants-added-report
      parameters:
      - name: campaignId
        in: path
        description: Unique identifier of the flow that participant will be added to.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 200000000000001
      - name: operationId
        in: query
        description: Unique identifier of the operation.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: 03f2d474-0508-46bf-9f3d-d8e2c28adaea
      - name: applicationId
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: entityId
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowParticipantsReportResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    operationId: 03f2d474-0508-46bf-9f3d-d8e2c28adaea
                    campaignId: 200000000000001
                    callbackData: Callback Data
                    participants:
                    - identifyBy:
                        identifier: test@infobip.com
                        type: EMAIL
                      status: ACCEPTED
                    - identifyBy:
                        identifier: test2@infobip.com
                        type: EMAIL
                      status: REJECTED
                      errorReason: REJECTED_INVALID_CONTACT
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json: {}
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - flow:use
      - flow:read
      - flow:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /communication/1/flows/{campaignId}/participants:
    post:
      tags:
      - customer-engagement
      summary: Add Person to Flow
      description: Creates or updates a person and adds it to Flow
      operationId: add-people-to-flow
      parameters:
      - name: campaignId
        in: path
        description: Unique identifier of the flow that person will be added to
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10159347
      - name: phone
        in: query
        description: Person's phone number
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 19123456789
      - name: email
        in: query
        description: Person's email address
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: janewilliams@example.com
      - name: externalId
        in: query
        description: Unique ID for the person from an external system
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 8edb24b5-0319-48cd-a1d9-1e8bc5d577ab
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowPersonRequest'
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - flow:use
      - flow:manage
      x-deprecationInformation:
        deprecation: 2023-10-25T00:00:00.777+0000
        sunset: 2024-10-25T12:00:00.777+0000
        successorOperationId: add-flow-participants
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Remove person from flow
      description: Removes a participant with given identifier from the flow.
      operationId: remove-people-from-flow
      parameters:
      - name: campaignId
        in: path
        description: Unique identifier of the flow that person will be removed from.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10159347
      - name: phone
        in: query
        description: Person's phone number.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 19123456789
      - name: email
        in: query
        description: Person's email address.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: janewilliams@example.com
      - name: externalId
        in: query
        description: Unique ID for the person from an external system.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 8edb24b5-0319-48cd-a1d9-1e8bc5d577ab
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - flow:use
      - flow:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /forms/1/forms:
    get:
      tags:
      - customer-engagement
      summary: Get forms
      description: Use this method to get a list of forms.
      operationId: get-forms
      parameters:
      - name: offset
        in: query
        description: Skip first {offset} forms of the list.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
        example: 60
      - name: limit
        in: query
        description: The maximum number of returned forms. Maximum value is `100`.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 25
        example: 30
      - name: formType
        in: query
        description: The type of returned forms.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - OPT_IN
          - OPT_OUT
          - FACEBOOK
          - LIVECHAT
          - APPLE
        example: APPLE
      - name: formStatus
        in: query
        description: The status of returned forms.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormStatus'
        example: ACTIVE
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormListDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                    forms:
                    - id: f23f0f7c-9898-4feb-8f21-5afe2c29db7e
                      name: Test form
                      elements:
                      - component: TEXT
                        fieldId: first_name
                        personField: firstName
                        label: First Name
                        isRequired: false
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 255
                          sample: James
                          forbiddenSymbols:
                          - ^
                          - '&'
                          - <
                          - '>'
                          - '"'
                          - /
                          - \
                          - '

                            '
                          - ''
                          - ':'
                          - (
                          - )
                          - '{'
                          - '}'
                          - '='
                          - ;
                          - '#'
                          - '|'
                          - +
                          - '%'
                          - '*'
                          - '?'
                          - '['
                          - ']'
                        placeholder: First Name
                      - component: TEXT
                        fieldId: last_name
                        personField: lastName
                        label: Last Name
                        isRequired: false
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 255
                          sample: James
                          forbiddenSymbols:
                          - ^
                          - '&'
                          - <
                          - '>'
                          - '"'
                          - /
                          - \
                          - '

                            '
                          - ''
                          - ':'
                          - (
                          - )
                          - '{'
                          - '}'
                          - '='
                          - ;
                          - '#'
                          - '|'
                          - +
                          - '%'
                          - '*'
                          - '?'
                          - '['
                          - ']'
                        placeholder: Last Name
                      - component: TEXT
                        fieldId: company
                        personField: 267ce64a-1a26-4326-9036-6384696f39c8
                        label: Company
                        isRequired: false
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 1000
                          sample: Lorem ipsum
                        placeholder: Company
                      - component: TEXT
                        fieldId: country
                        personField: country
                        label: Country
                        isRequired: false
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 1000
                          sample: Lorem ipsum
                        placeholder: Country
                      - component: EMAIL
                        fieldId: email
                        personField: email
                        label: Email Address
                        isRequired: true
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 1000
                          pattern: (?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])
                          sample: email@example.com
                        placeholder: Email
                      - component: TEXTAREA
                        fieldId: business_needs
                        label: Business Needs
                        isRequired: false
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 3000
                          sample: Lorem ipsum ...
                        placeholder: ''
                      - component: TEXT
                        fieldId: offer_id
                        label: OfferId
                        isRequired: false
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 1000
                          sample: Lorem ipsum
                        placeholder: OfferId
                      - component: TEXT
                        fieldId: plan_id
                        label: PlanId
                        isRequired: false
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 1000
                          sample: Lorem ipsum
                        placeholder: PlanId
                      - component: TEXT
                        fieldId: subscription_id
                        label: SubscriptionId
                        isRequired: false
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 1000
                          sample: Lorem ipsum
                        placeholder: SubscriptionId
                      - component: TEXT
                        fieldId: Tenant_id
                        label: TenantId
                        isRequired: false
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 1000
                          sample: Lorem ipsum
                        placeholder: TenantId
                      - component: SUBMIT_BUTTON
                        label: Submit
                      createdAt: 2022-07-11T06:38:12.757+0000
                      updatedAt: 2022-07-11T06:45:12.826+0000
                      resubmitEnabled: true
                      formType: OPT_IN
                      formStatus: ACTIVE
                    - id: 7370b24c-9788-4a52-a6a4-047cecbe2df2
                      name: test
                      elements:
                      - component: EMAIL
                        fieldId: email
                        personField: email
                        label: Email
                        isRequired: false
                        isHidden: false
                        additionalConfiguration: {}
                        validationRules:
                          maxLength: 1000
                          pattern: (?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])
                          sample: email@example.com
                        placeholder: Email
                      - component: SUBMIT_BUTTON
                        label: Submit
                      createdAt: 2022-06-15T13:21:38.195+0000
                      updatedAt: 2022-06-15T13:21:46.286+0000
                      resubmitEnabled: true
                      formType: OPT_IN
                      formStatus: ACTIVE
                    offset: 0
                    limit: 25
                    total: 2
            application/xml:
              schema:
                $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormListDto'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiFormListDto>\n      \n  <forms>\n            \n    <forms>\n                  \n      <id>f23f0f7c-9898-4feb-8f21-5afe2c29db7e</id>\n                  \n      <name>Test form</name>\n                  \n      <elements>\n                        \n        <elements>\n                              \n          <component>TEXT</component>\n                              \n          <fieldId>first_name</fieldId>\n                              \n          <personField>firstName</personField>\n                              \n          <label>First Name</label>\n                              \n          <isRequired>false</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>255</maxLength>\n                                    \n            <sample>James</sample>\n                                    \n            <forbiddenSymbols>\n                                          \n              <forbiddenSymbols>^</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>&amp;</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>&lt;</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>&gt;</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>\"</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>/</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>\\</forbiddenSymbols>\n                                          \n              <forbiddenSymbols/>\n                                          \n              <forbiddenSymbols>&#13;</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>:</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>(</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>)</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>{</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>}</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>=</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>;</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>#</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>|</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>+</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>%</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>*</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>?</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>[</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>]</forbiddenSymbols>\n                                      \n            </forbiddenSymbols>\n                                \n          </validationRules>\n                              \n          <placeholder>First Name</placeholder>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>TEXT</component>\n                              \n          <fieldId>last_name</fieldId>\n                              \n          <personField>lastName</personField>\n                              \n          <label>Last Name</label>\n                              \n          <isRequired>false</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>255</maxLength>\n                                    \n            <sample>James</sample>\n                                    \n            <forbiddenSymbols>\n                                          \n              <forbiddenSymbols>^</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>&amp;</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>&lt;</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>&gt;</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>\"</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>/</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>\\</forbiddenSymbols>\n                                          \n              <forbiddenSymbols/>\n                                          \n              <forbiddenSymbols>&#13;</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>:</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>(</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>)</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>{</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>}</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>=</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>;</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>#</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>|</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>+</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>%</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>*</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>?</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>[</forbiddenSymbols>\n                                          \n              <forbiddenSymbols>]</forbiddenSymbols>\n                                      \n            </forbiddenSymbols>\n                                \n          </validationRules>\n                              \n          <placeholder>Last Name</placeholder>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>TEXT</component>\n                              \n          <fieldId>company</fieldId>\n                              \n          <personField>267ce64a-1a26-4326-9036-6384696f39c8</personField>\n                              \n          <label>Company</label>\n                              \n          <isRequired>false</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>1000</maxLength>\n                                    \n            <sample>Lorem ipsum</sample>\n                                \n          </validationRules>\n                              \n          <placeholder>Company</placeholder>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>TEXT</component>\n                              \n          <fieldId>country</fieldId>\n                              \n          <personField>country</personField>\n                              \n          <label>Country</label>\n                              \n          <isRequired>false</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>1000</maxLength>\n                                    \n            <sample>Lorem ipsum</sample>\n                                \n          </validationRules>\n                              \n          <placeholder>Country</placeholder>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>EMAIL</component>\n                              \n          <fieldId>email</fieldId>\n                              \n          <personField>email</personField>\n                              \n          <label>Email Address</label>\n                              \n          <isRequired>true</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>1000</maxLength>\n                                    \n            <pattern>(?:[a-z0-9!#$%&amp;'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&amp;'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])</pattern>\n                                    \n            <sample>email@example.com</sample>\n                                \n          </validationRules>\n                              \n          <placeholder>Email</placeholder>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>TEXTAREA</component>\n                              \n          <fieldId>business_needs</fieldId>\n                              \n          <label>Business Needs</label>\n                              \n          <isRequired>false</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>3000</maxLength>\n                                    \n            <sample>Lorem ipsum ...</sample>\n                                \n          </validationRules>\n                              \n          <placeholder/>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>TEXT</component>\n                              \n          <fieldId>offer_id</fieldId>\n                              \n          <label>OfferId</label>\n                              \n          <isRequired>false</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>1000</maxLength>\n                                    \n            <sample>Lorem ipsum</sample>\n                                \n          </validationRules>\n                              \n          <placeholder>OfferId</placeholder>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>TEXT</component>\n                              \n          <fieldId>plan_id</fieldId>\n                              \n          <label>PlanId</label>\n                              \n          <isRequired>false</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>1000</maxLength>\n                                    \n            <sample>Lorem ipsum</sample>\n                                \n          </validationRules>\n                              \n          <placeholder>PlanId</placeholder>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>TEXT</component>\n                              \n          <fieldId>subscription_id</fieldId>\n                              \n          <label>SubscriptionId</label>\n                              \n          <isRequired>false</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>1000</maxLength>\n                                    \n            <sample>Lorem ipsum</sample>\n                                \n          </validationRules>\n                              \n          <placeholder>SubscriptionId</placeholder>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>TEXT</component>\n                              \n          <fieldId>Tenant_id</fieldId>\n                              \n          <label>TenantId</label>\n                              \n          <isRequired>false</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>1000</maxLength>\n                                    \n            <sample>Lorem ipsum</sample>\n                                \n          </validationRules>\n                              \n          <placeholder>TenantId</placeholder>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>SUBMIT_BUTTON</component>\n                              \n          <label>Submit</label>\n                          \n        </elements>\n                    \n      </elements>\n                  \n      <createdAt>2022-07-11T06:38:12.757+0000</createdAt>\n                  \n      <updatedAt>2022-07-11T06:45:12.826+0000</updatedAt>\n                  \n      <resubmitEnabled>true</resubmitEnabled>\n                  \n      <formType>OPT_IN</formType>\n                  \n      <formStatus>ACTIVE</formStatus>\n              \n    </forms>\n            \n    <forms>\n                  \n      <id>7370b24c-9788-4a52-a6a4-047cecbe2df2</id>\n                  \n      <name>test</name>\n                  \n      <elements>\n                        \n        <elements>\n                              \n          <component>EMAIL</component>\n                              \n          <fieldId>email</fieldId>\n                              \n          <personField>email</personField>\n                              \n          <label>Email</label>\n                              \n          <isRequired>false</isRequired>\n                              \n          <isHidden>false</isHidden>\n                              \n          <additionalConfiguration/>\n                              \n          <validationRules>\n                                    \n            <maxLength>1000</maxLength>\n                                    \n            <pattern>(?:[a-z0-9!#$%&amp;'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&amp;'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])</pattern>\n                                    \n            <sample>email@example.com</sample>\n                                \n          </validationRules>\n                              \n          <placeholder>Email</placeholder>\n                          \n        </elements>\n                        \n        <elements>\n                              \n          <component>SUBMIT_BUTTON</component>\n                              \n          <label>Submit</label>\n                          \n        </elements>\n                    \n      </elements>\n                  \n      <createdAt>2022-06-15T13:21:38.195+0000</createdAt>\n                  \n      <updatedAt>2022-06-15T13:21:46.286+0000</updatedAt>\n                  \n      <resubmitEnabled>true</resubmitEnabled>\n                  \n      <formType>OPT_IN</formType>\n                  \n      <formStatus>ACTIVE</formStatus>\n              \n    </forms>\n        \n  </forms>\n      \n  <offset>0</offset>\n      \n  <limit>25</limit>\n      \n  <total>2</total>\n  \n</ApiFormListDto>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - web:sdk
      - forms:manage
      - forms:read
  /forms/1/forms/{id}:
    get:
      tags:
      - customer-engagement
      summary: Get form
      description: Use this method to get a form by its ID.
      operationId: get-form
      parameters:
      - name: id
        in: path
        description: ID of a form
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: f7cf1606-e155-40eb-9721-78183d268d24
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormDto'
              examples:
                Company Newsletter:
                  summary: Company Newsletter
                  description: Company Newsletter
                  value:
                    id: f23f0f7c-9898-4feb-8f21-5afe2c29db7e
                    name: Test Form
                    elements:
                    - component: TEXT
                      fieldId: first_name
                      personField: firstName
                      label: First Name
                      isRequired: false
                      isHidden: false
                      additionalConfiguration: {}
                      validationRules:
                        maxLength: 255
                        sample: James
                        forbiddenSymbols:
                        - ^
                        - '&'
                        - <
                        - '>'
                        - '"'
                        - /
                        - \
                        - '

                          '
                        - ''
                        - ':'
                        - (
                        - )
                        - '{'
                        - '}'
                        - '='
                        - ;
                        - '#'
                        - '|'
                        - +
                        - '%'
                        - '*'
                        - '?'
                        - '['
                        - ']'
                      placeholder: First Name
                    - component: TEXT
                      fieldId: last_name
                      personField: lastName
                      label: Last Name
                      isRequired: false
                      isHidden: false
                      additionalConfiguration: {}
                      validationRules:
                        maxLength: 255
                        sample: James
                        forbiddenSymbols:
                        - ^
                        - '&'
                        - <
                        - '>'
                        - '"'
                        - /
                        - \
                        - '

                          '
                        - ''
                        - ':'
                        - (
                        - )
                        - '{'
                        - '}'
                        - '='
                        - ;
                        - '#'
                        - '|'
                        - +
                        - '%'
                        - '*'
                        - '?'
                        - '['
                        - ']'
                      placeholder: Last Name
                    - component: TEXT
                      fieldId: company
                      personField: 267ce64a-1a26-4326-9036-6384696f39c8
                      label: Company
                      isRequired: false
                      isHidden: false
                      additionalConfiguration: {}
                      validationRules:
                        maxLength: 1000
                        sample: Lorem ipsum
                      placeholder: Company
                    - component: TEXT
                      fieldId: country
                      personField: country
                      label: Country
                      isRequired: false
                      isHidden: false
                      additionalConfiguration: {}
                      validationRules:
                        maxLength: 1000
                        sample: Lorem ipsum
                      placeholder: Country
                    - component: EMAIL
                      fieldId: email
                      personField: email
                      label: Email Address
                      isRequired: true
                      isHidden: false
                      additionalConfiguration: {}
                      validationRules:
                        maxLength: 1000
                        pattern: (?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])
                        sample: email@example.com
                      placeholder: Email
                    - component: TEXTAREA
                      fieldId: business_needs
                      label: Business Needs
                      isRequired: false
                      isHidden: false
                      additionalConfiguration: {}
                      validationRules:
                        maxLength: 3000
                        sample: Lorem ipsum ...
                      placeholder: ''
                    - component: TEXT
                      fieldId: offer_id
                      label: OfferId
                      isRequired: false
                      isHidden: false
                      additionalConfiguration: {}
                      validationRules:
                        maxLength: 1000
                        sample: Lorem ipsum
                      placeholder: OfferId
                    - component: TEXT
                      fieldId: plan_id
                      label: PlanId
                      isRequired: false
                      isHidden: false
                      additionalConfiguration: {}
                      validationRules:
                        maxLength: 1000
                        sample: Lorem ipsum
                      placeholder: PlanId
                    - component: TEXT
                      fieldId: subscription_id
                      label: SubscriptionId
                      isRequired: false
                      isHidden: false
                      additionalConfiguration: {}
                      validationRules:
                        maxLength: 1000
                        sample: Lorem ipsum
                      placeholder: SubscriptionId
                    - component: TEXT
                      fieldId: Tenant_id
                      label: TenantId
                      isRequired: false
                      isHidden: false
                      additionalConfiguration: {}
                      validationRules:
                        maxLength: 1000
                        sample: Lorem ipsum
                      placeholder: TenantId
                    - component: SUBMIT_BUTTON
                      label: Submit
                    createdAt: 2022-07-11T06:38:12.757+0000
                    updatedAt: 2022-07-11T06:45:12.826+0000
                    resubmitEnabled: true
                    formType: OPT_IN
                    formStatus: ACTIVE
            application/xml:
              schema:
                $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormDto'
              examples:
                Company Newsletter:
                  summary: Company Newsletter
                  description: Company Newsletter
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiFormDto>\n      \n  <id>f23f0f7c-9898-4feb-8f21-5afe2c29db7e</id>\n      \n  <name>Test Form</name>\n      \n  <elements>\n            \n    <elements>\n                  \n      <component>TEXT</component>\n                  \n      <fieldId>first_name</fieldId>\n                  \n      <personField>firstName</personField>\n                  \n      <label>First Name</label>\n                  \n      <isRequired>false</isRequired>\n                  \n      <isHidden>false</isHidden>\n                  \n      <additionalConfiguration/>\n                  \n      <validationRules>\n                        \n        <maxLength>255</maxLength>\n                        \n        <sample>James</sample>\n                        \n        <forbiddenSymbols>\n                              \n          <forbiddenSymbols>^</forbiddenSymbols>\n                              \n          <forbiddenSymbols>&amp;</forbiddenSymbols>\n                              \n          <forbiddenSymbols>&lt;</forbiddenSymbols>\n                              \n          <forbiddenSymbols>&gt;</forbiddenSymbols>\n                              \n          <forbiddenSymbols>\"</forbiddenSymbols>\n                              \n          <forbiddenSymbols>/</forbiddenSymbols>\n                              \n          <forbiddenSymbols>\\</forbiddenSymbols>\n                              \n          <forbiddenSymbols/>\n                              \n          <forbiddenSymbols>&#13;</forbiddenSymbols>\n                              \n          <forbiddenSymbols>:</forbiddenSymbols>\n                              \n          <forbiddenSymbols>(</forbiddenSymbols>\n                              \n          <forbiddenSymbols>)</forbiddenSymbols>\n                              \n          <forbiddenSymbols>{</forbiddenSymbols>\n                              \n          <forbiddenSymbols>}</forbiddenSymbols>\n                              \n          <forbiddenSymbols>=</forbiddenSymbols>\n                              \n          <forbiddenSymbols>;</forbiddenSymbols>\n                              \n          <forbiddenSymbols>#</forbiddenSymbols>\n                              \n          <forbiddenSymbols>|</forbiddenSymbols>\n                              \n          <forbiddenSymbols>+</forbiddenSymbols>\n                              \n          <forbiddenSymbols>%</forbiddenSymbols>\n                              \n          <forbiddenSymbols>*</forbiddenSymbols>\n                              \n          <forbiddenSymbols>?</forbiddenSymbols>\n                              \n          <forbiddenSymbols>[</forbiddenSymbols>\n                              \n          <forbiddenSymbols>]</forbiddenSymbols>\n                          \n        </forbiddenSymbols>\n                    \n      </validationRules>\n                  \n      <placeholder>First Name</placeholder>\n              \n    </elements>\n            \n    <elements>\n                  \n      <component>TEXT</component>\n                  \n      <fieldId>last_name</fieldId>\n                  \n      <personField>lastName</personField>\n                  \n      <label>Last Name</label>\n                  \n      <isRequired>false</isRequired>\n                  \n      <isHidden>false</isHidden>\n                  \n      <additionalConfiguration/>\n                  \n      <validationRules>\n                        \n        <maxLength>255</maxLength>\n                        \n        <sample>James</sample>\n                        \n        <forbiddenSymbols>\n                              \n          <forbiddenSymbols>^</forbiddenSymbols>\n                              \n          <forbiddenSymbols>&amp;</forbiddenSymbols>\n                              \n          <forbiddenSymbols>&lt;</forbiddenSymbols>\n                              \n          <forbiddenSymbols>&gt;</forbiddenSymbols>\n                              \n          <forbiddenSymbols>\"</forbiddenSymbols>\n                              \n          <forbiddenSymbols>/</forbiddenSymbols>\n                              \n          <forbiddenSymbols>\\</forbiddenSymbols>\n                              \n          <forbiddenSymbols/>\n                              \n          <forbiddenSymbols>&#13;</forbiddenSymbols>\n                              \n          <forbiddenSymbols>:</forbiddenSymbols>\n                              \n          <forbiddenSymbols>(</forbiddenSymbols>\n                              \n          <forbiddenSymbols>)</forbiddenSymbols>\n                              \n          <forbiddenSymbols>{</forbiddenSymbols>\n                              \n          <forbiddenSymbols>}</forbiddenSymbols>\n                              \n          <forbiddenSymbols>=</forbiddenSymbols>\n                              \n          <forbiddenSymbols>;</forbiddenSymbols>\n                              \n          <forbiddenSymbols>#</forbiddenSymbols>\n                              \n          <forbiddenSymbols>|</forbiddenSymbols>\n                              \n          <forbiddenSymbols>+</forbiddenSymbols>\n                              \n          <forbiddenSymbols>%</forbiddenSymbols>\n                              \n          <forbiddenSymbols>*</forbiddenSymbols>\n                              \n          <forbiddenSymbols>?</forbiddenSymbols>\n                              \n          <forbiddenSymbols>[</forbiddenSymbols>\n                              \n          <forbiddenSymbols>]</forbiddenSymbols>\n                          \n        </forbiddenSymbols>\n                    \n      </validationRules>\n                  \n      <placeholder>Last Name</placeholder>\n              \n    </elements>\n            \n    <elements>\n                  \n      <component>TEXT</component>\n                  \n      <fieldId>company</fieldId>\n                  \n      <personField>267ce64a-1a26-4326-9036-6384696f39c8</personField>\n                  \n      <label>Company</label>\n                  \n      <isRequired>false</isRequired>\n                  \n      <isHidden>false</isHidden>\n                  \n      <additionalConfiguration/>\n                  \n      <validationRules>\n                        \n        <maxLength>1000</maxLength>\n                        \n        <sample>Lorem ipsum</sample>\n                    \n      </validationRules>\n                  \n      <placeholder>Company</placeholder>\n              \n    </elements>\n            \n    <elements>\n                  \n      <component>TEXT</component>\n                  \n      <fieldId>country</fieldId>\n                  \n      <personField>country</personField>\n                  \n      <label>Country</label>\n                  \n      <isRequired>false</isRequired>\n                  \n      <isHidden>false</isHidden>\n                  \n      <additionalConfiguration/>\n                  \n      <validationRules>\n                        \n        <maxLength>1000</maxLength>\n                        \n        <sample>Lorem ipsum</sample>\n                    \n      </validationRules>\n                  \n      <placeholder>Country</placeholder>\n              \n    </elements>\n            \n    <elements>\n                  \n      <component>EMAIL</component>\n                  \n      <fieldId>email</fieldId>\n                  \n      <personField>email</personField>\n                  \n      <label>Email Address</label>\n                  \n      <isRequired>true</isRequired>\n                  \n      <isHidden>false</isHidden>\n                  \n      <additionalConfiguration/>\n                  \n      <validationRules>\n                        \n        <maxLength>1000</maxLength>\n                        \n        <pattern>(?:[a-z0-9!#$%&amp;'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&amp;'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])</pattern>\n                        \n        <sample>email@example.com</sample>\n                    \n      </validationRules>\n                  \n      <placeholder>Email</placeholder>\n              \n    </elements>\n            \n    <elements>\n                  \n      <component>TEXTAREA</component>\n                  \n      <fieldId>business_needs</fieldId>\n                  \n      <label>Business Needs</label>\n                  \n      <isRequired>false</isRequired>\n                  \n      <isHidden>false</isHidden>\n                  \n      <additionalConfiguration/>\n                  \n      <validationRules>\n                        \n        <maxLength>3000</maxLength>\n                        \n        <sample>Lorem ipsum ...</sample>\n                    \n      </validationRules>\n                  \n      <placeholder/>\n              \n    </elements>\n            \n    <elements>\n                  \n      <component>TEXT</component>\n                  \n      <fieldId>offer_id</fieldId>\n                  \n      <label>OfferId</label>\n                  \n      <isRequired>false</isRequired>\n                  \n      <isHidden>false</isHidden>\n                  \n      <additionalConfiguration/>\n                  \n      <validationRules>\n                        \n        <maxLength>1000</maxLength>\n                        \n        <sample>Lorem ipsum</sample>\n                    \n      </validationRules>\n                  \n      <placeholder>OfferId</placeholder>\n              \n    </elements>\n            \n    <elements>\n                  \n      <component>TEXT</component>\n                  \n      <fieldId>plan_id</fieldId>\n                  \n      <label>PlanId</label>\n                  \n      <isRequired>false</isRequired>\n                  \n      <isHidden>false</isHidden>\n                  \n      <additionalConfiguration/>\n                  \n      <validationRules>\n                        \n        <maxLength>1000</maxLength>\n                        \n        <sample>Lorem ipsum</sample>\n                    \n      </validationRules>\n                  \n      <placeholder>PlanId</placeholder>\n              \n    </elements>\n            \n    <elements>\n                  \n      <component>TEXT</component>\n                  \n      <fieldId>subscription_id</fieldId>\n                  \n      <label>SubscriptionId</label>\n                  \n      <isRequired>false</isRequired>\n                  \n      <isHidden>false</isHidden>\n                  \n      <additionalConfiguration/>\n                  \n      <validationRules>\n                        \n        <maxLength>1000</maxLength>\n                        \n        <sample>Lorem ipsum</sample>\n                    \n      </validationRules>\n                  \n      <placeholder>SubscriptionId</placeholder>\n              \n    </elements>\n            \n    <elements>\n                  \n      <component>TEXT</component>\n                  \n      <fieldId>Tenant_id</fieldId>\n                  \n      <label>TenantId</label>\n                  \n      <isRequired>false</isRequired>\n                  \n      <isHidden>false</isHidden>\n                  \n      <additionalConfiguration/>\n                  \n      <validationRules>\n                        \n        <maxLength>1000</maxLength>\n                        \n        <sample>Lorem ipsum</sample>\n                    \n      </validationRules>\n                  \n      <placeholder>TenantId</placeholder>\n              \n    </elements>\n            \n    <elements>\n                  \n      <component>SUBMIT_BUTTON</component>\n                  \n      <label>Submit</label>\n              \n    </elements>\n        \n  </elements>\n      \n  <createdAt>2022-07-11T06:38:12.757+0000</createdAt>\n      \n  <updatedAt>2022-07-11T06:45:12.826+0000</updatedAt>\n      \n  <resubmitEnabled>true</resubmitEnabled>\n      \n  <formType>OPT_IN</formType>\n      \n  <formStatus>ACTIVE</formStatus>\n  \n</ApiFormDto>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Form is not found
            application/xml:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Form is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - APIKeyHeader: []
      x-scopes:
      - web:sdk
      - forms:manage
      - forms:use
      - forms:read
  /forms/1/forms/{id}/views:
    post:
      tags:
      - customer-engagement
      summary: Increment form view count
      description: Use this method to increase the view counter of a specific form. It's used for proper statistics calculation. Statistics are available on the form performance page on the Portal.
      operationId: increment-view-count
      parameters:
      - name: id
        in: path
        description: ID of a form
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: cec5dfd2-4238-48e0-933b-9acbdb2e6f5f
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiStatusResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    status: OK
            application/xml:
              schema:
                $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiStatusResponse'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiStatusResponse>\n  <status>OK</status>\n</ApiStatusResponse>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Form is not found
            application/xml:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Form is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - APIKeyHeader: []
      x-scopes:
      - web:sdk
      - forms:manage
      - forms:use
      - forms:read
  /forms/1/forms/{id}/data:
    post:
      tags:
      - customer-engagement
      summary: Submit form data
      description: Use this method to submit form data.
      operationId: submit-form-data
      parameters:
      - name: ib-submission-source
        in: header
        description: By sending source information you will be able to see Analytics by Source – It reflects the submission rates by source if your form is present in numerous places.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: ib-submission-form-campaign
        in: header
        description: By sending campaign information you will be able to see Analytics by Campaign – It reflects the submission rates by campaign if your form is included in multiple campaigns.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: ID of a form
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: f7cf1606-e155-40eb-9721-78183d268d24
      requestBody:
        description: Form Data
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormDataPayloadMap'
            examples:
              Request example:
                summary: Request example
                value: firstName=John&Email=john.doe%40example.com
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormDataPayloadMap'
            examples:
              Request example:
                summary: Request example
                value: '----ExampleFormBoundary7MA4YWxkTrZu0gW

                  Content-Disposition: form-data; name="firstName"


                  John

                  ----ExampleFormBoundary7MA4YWxkTrZu0gW

                  Content-Disposition: form-data; name="Email"


                  john.doe@example.com

                  ----ExampleFormBoundary7MA4YWxkTrZu0gW'
          application/json:
            schema:
              $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormDataPayloadMap'
            examples:
              Request example:
                summary: Request example
                value:
                  string: string
                  number: 26
                  float: 1.5
                  boolean: true
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiStatusResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    status: OK
            application/xml:
              schema:
                $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiStatusResponse'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiStatusResponse>\n  <status>OK</status>\n</ApiStatusResponse>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: FORBIDDEN
                        text: Form is not submittable using the API
            application/xml:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>FORBIDDEN</messageId>\n                  \n      <text>Form is not submittable using API</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Form is not found
            application/xml:
              schema:
                $ref: '#/components/schemas/265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Form is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - APIKeyHeader: []
      x-scopes:
      - web:sdk
      - forms:manage
      - forms:use
      - forms:read
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /ccaas/1/conversations:
    get:
      tags:
      - customer-engagement
      summary: Get conversations
      description: Use this method to get a list of conversations with pagination and filtering option. Using the filter is optional. The result can be filtered by one or many optional filters described in parameters. <a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: get-conversations
      parameters:
      - name: conversationIds
        in: query
        description: Optional. List of conversation Ids.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: queueIds
        in: query
        description: Optional. List of queue Ids.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: tagNames
        in: query
        description: Optional. List of tag names.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: agentId
        in: query
        description: Optional. Id of an agent assigned to conversations.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: status
        in: query
        description: Optional. Conversation status.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - OPEN
          - WAITING
          - SOLVED
          - CLOSED
      - name: priority
        in: query
        description: Optional. Conversation priority.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - URGENT
          - HIGH
          - NORMAL
          - LOW
      - name: createdAfter
        in: query
        description: 'Optional. Filter results created after specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdBefore
        in: query
        description: 'Optional. Filter results created before specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedAfter
        in: query
        description: 'Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedBefore
        in: query
        description: 'Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: closedAfter
        in: query
        description: 'Optional. Filter results closed after specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: closedBefore
        in: query
        description: 'Optional. Filter results closed before specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: 'This parameter is used to order your results.

          If an order is not given, the default order id:asc will be applied.

          Possible ordering fields are properties.

          Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    post:
      tags:
      - customer-engagement
      summary: Create conversation
      description: Use this method to create a new conversation. All conversation parameters are optional. <a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: create-conversation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 1ddece93-041f-42ac-8e25-d05801dfe358
                    topic: Conversation topic
                    summary: Conversation summary
                    status: OPEN
                    priority: HIGH
                    queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
                    agentId: c856e230-a8cd-498b-9996-42bbed35029a
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}:
    get:
      tags:
      - customer-engagement
      summary: Get conversation
      description: Use this method to get a single conversation. <a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: get-conversation
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation to get.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 1ddece93-041f-42ac-8e25-d05801dfe358
                    topic: Conversation topic
                    summary: Conversation summary
                    status: OPEN
                    priority: HIGH
                    queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
                    agentId: c856e230-a8cd-498b-9996-42bbed35029a
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Update conversation
      description: Use this method to update a conversation. Closed conversations cannot be changed. To change an assignment to another agent or a bot, use [Change conversation assignment](https://www.infobip.com/docs/api/customer-engagement/conversations/change-conversation-assignment).<a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: update-conversation
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation being updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 1ddece93-041f-42ac-8e25-d05801dfe358
                    topic: Conversation topic
                    summary: Conversation summary
                    status: OPEN
                    priority: HIGH
                    queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
                    agentId: c856e230-a8cd-498b-9996-42bbed35029a
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
                Conversation is closed:
                  summary: Conversation is closed
                  description: Conversation is closed
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Closed conversation cannot be changed
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    patch:
      tags:
      - customer-engagement
      summary: Patch conversation
      description: Use this method to patch a conversation. Closed conversations cannot be changed. To change an assignment to another agent or a bot, use [Change conversation assignment](https://www.infobip.com/docs/api/customer-engagement/conversations/change-conversation-assignment).<a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: patch-conversation
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation being patched.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.PatchConversationApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 1ddece93-041f-42ac-8e25-d05801dfe358
                    topic: Conversation topic
                    summary: Conversation summary
                    status: OPEN
                    priority: HIGH
                    queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
                    agentId: c856e230-a8cd-498b-9996-42bbed35029a
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
                Conversation is closed:
                  summary: Conversation is closed
                  description: Conversation is closed
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Closed conversation cannot be changed
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}/tags:
    post:
      tags:
      - customer-engagement
      summary: Add tag to conversation
      description: Use this method to add a tag to the conversation. With tag(s) you can categorize conversations for assignment and/or reporting purposes. <a href="https://www.infobip.com/docs/conversations-api/tags" target="_blank">More info</a>
      operationId: add-conversation-tag
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation the tag is added to.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AddTagToConversationApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Success request response:
                  summary: Success request response
                  description: Success request response
                  value:
                    statusCode: SUCCESS
                    message: Tag added to conversation successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid tag name:
                  summary: Invalid tag name
                  description: Invalid tag name
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid tagName 'INVALID_TAG_NAME' given! No such entity exists.
                Conversation is closed:
                  summary: Conversation is closed
                  description: Conversation is closed
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Closed conversation cannot be changed
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}/assignee:
    put:
      tags:
      - customer-engagement
      summary: Change conversation assignment
      description: Use this method to update a conversation assignee. Assignee cannot be updated in closed conversations. For Agent Takeovers (bot replaced by an agent), the Infobip platform will additionally update [Answers](https://www.infobip.com/docs/answers) that a bot is no longer in control of the conversation. <a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: change-conversation-assignment
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation for which the assignment is to be updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AssignAgentApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel'
              examples:
                Success request response:
                  summary: Success request response
                  description: Success request response
                  value:
                    id: 1ddece93-041f-42ac-8e25-d05801dfe358
                    topic: Conversation topic
                    summary: Conversation summary
                    status: OPEN
                    priority: HIGH
                    queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
                    agentId: c856e230-a8cd-498b-9996-42bbed35029a
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid agent Id:
                  summary: Invalid agent Id
                  description: Invalid agent Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
                Conversation is closed:
                  summary: Conversation is closed
                  description: Conversation is closed
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Closed conversation cannot be changed
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    delete:
      tags:
      - customer-engagement
      summary: Unassign conversation agent
      description: Use this method to remove an assigned agent from conversation. <a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: unassign-conversation-agent
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation to unassign agent from.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel'
              examples:
                Success request response:
                  summary: Success request response
                  description: Success request response
                  value:
                    id: 1ddece93-041f-42ac-8e25-d05801dfe358
                    topic: Conversation topic
                    summary: Conversation summary
                    status: OPEN
                    priority: HIGH
                    queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
                    agentId: c856e230-a8cd-498b-9996-42bbed35029a
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
                Conversation is closed:
                  summary: Conversation is closed
                  description: Conversation is closed
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Closed conversation cannot be changed
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}/tags/{tagName}:
    delete:
      tags:
      - customer-engagement
      summary: Remove tag from conversation
      description: Use this method to remove the tag from the conversation. Operation only deletes the link between a tag and the conversation. <a href="https://www.infobip.com/docs/conversations-api/tags" target="_blank">More info</a>
      operationId: delete-conversation-tag
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation to remove/unlink the tag from.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: tagName
        in: path
        description: Name of the tag to remove/unlink from conversation. This value must be URL-encoded.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Success request response:
                  summary: Success request response
                  description: Success request response
                  value:
                    statusCode: SUCCESS
                    message: Tag removed successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid tag name:
                  summary: Invalid tag name
                  description: Invalid tag name
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid tagName 'INVALID_TAG_NAME' given! No such entity exists.
                Conversation is closed:
                  summary: Conversation is closed
                  description: Conversation is closed
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Closed conversation cannot be changed
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}/route:
    post:
      tags:
      - customer-engagement
      summary: Route conversation
      description: 'Use this method to route the existing conversation.

        This method will remove the assigned agent from a conversation (if one exists), and send the conversation to the [routing process](../#customer-engagement/conversations/update-routing).

        Closed Conversations cannot be routed.'
      operationId: route-conversation
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation being routed.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationResultPage'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 1ddece93-041f-42ac-8e25-d05801dfe358
                    topic: Conversation topic
                    summary: Conversation summary
                    status: OPEN
                    priority: HIGH
                    queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
                    agentId: c856e230-a8cd-498b-9996-42bbed35029a
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
                Conversation is closed:
                  summary: Conversation is closed
                  description: Conversation is closed
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Closed conversation cannot be changed
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}/simulate-routing:
    get:
      tags:
      - customer-engagement
      summary: Simulate routing result for conversation
      description: 'Use this method to simulate routing for an existing conversation.

        This method will resolve the routing rule applicable to the current conversation state and return the queue ID and priority

        that would be applied if the conversation was actually routed at this moment.

        Closed conversations cannot be routed.

        '
      operationId: simulate-routing-result-for-conversation
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation on which routing is simulated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationRoutingResultApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 1ddece93-041f-42ac-8e25-d05801dfe358
                    queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
                    priority: HIGH
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
                Conversation is closed:
                  summary: Conversation is closed
                  description: Conversation is closed
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Closed conversation cannot be changed
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
  /ccaas/1/conversations/{conversationId}/related-comments:
    get:
      tags:
      - customer-engagement
      summary: Get related comments
      description: 'Use this method to return social comments related to a specified inbound comment within a conversation.

        It returns up to 50 older and 50 newer comments that are on the same hierarchy level as the inbound comment.

        '
      operationId: get-related-comments
      parameters:
      - name: conversationId
        in: path
        description: ID of the conversation to get.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedCommentsApiResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Missing Conversation Id:
                  summary: Missing Conversation Id
                  description: Missing Conversation Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid conversationId 'related-comments' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
  /ccaas/1/conversations/{conversationId}/links:
    get:
      tags:
      - customer-engagement
      summary: Get linked conversations
      description: Use this method to get a list of conversations linked to the specified conversation. <a href="https://www.infobip.com/docs/conversations-api/linked-conversations" target="_blank">More info</a>
      operationId: get-linked-conversations
      parameters:
      - name: conversationId
        in: path
        description: ID of the conversation to get links for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversations'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    linkedConversations:
                    - parentConversation:
                        conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                        createdAt: '2024-01-01T00:00:00.000+00:00'
                        updatedAt: '2024-01-01T00:00:00.000+00:00'
                        agentId: c856e230-a8cd-498b-9996-42bbed35029a
                        topic: Billing inquiry
                        channel: WHATSAPP
                        status: OPEN
                        customerDisplayName: John Doe
                      childConversation:
                        conversationId: e43bc422-09c9-4591-8b9d-82debcf04e0d
                        createdAt: '2024-01-01T00:00:00.000+00:00'
                        updatedAt: '2024-01-01T00:00:00.000+00:00'
                        agentId: c856e230-a8cd-498b-9996-42bbed35029a
                        topic: Follow-up
                        channel: LIVE_CHAT
                        status: OPEN
                        customerDisplayName: John Doe
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
  /ccaas/1/tags:
    get:
      tags:
      - customer-engagement
      summary: Get tags
      description: Use this method to get a list of tags with pagination and filtering options. Using a filter is optional. The result can be filtered only by conversation Id so the result list will be tagged for a specific conversation. <a href="https://www.infobip.com/docs/conversations-api/tags" target="_blank">More info</a>
      operationId: get-tags
      parameters:
      - name: conversationId
        in: query
        description: Optional. Conversation Ids linked to tags.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: Optional. Tag name.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: 'This parameter is used to order your results.

          If an order is not given, the default order id:asc will be applied.

          Possible ordering fields are properties.

          Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TagsApiResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    post:
      tags:
      - customer-engagement
      summary: Create tag
      description: Use this method to create a new tag. Tags can be assigned to the conversations to categorize them into topics or customer intents. Tags can be created ad hoc over the create tag method or automatically within the journey automation flow when a conversation is transferred to Agents. <a href="https://www.infobip.com/docs/conversations-api/tags" target="_blank">More info</a>
      operationId: create-tag
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateTagApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateTagApiRequest'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    name: Tag 1
                    createdAt: '2024-01-01T00:00:00.000+00:00'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
                Tag already exists:
                  summary: Tag already exists
                  description: Tag already exists
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Tag already exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/tags/{tagName}:
    delete:
      tags:
      - customer-engagement
      summary: Delete tag
      description: 'Use this method to delete the tag.

        Deleting tag will remove the tag from all associated conversations. This operation cannot be reverted! <a href="https://www.infobip.com/docs/conversations-api/tags" target="_blank">More info</a>'
      operationId: delete-tags
      parameters:
      - name: tagName
        in: path
        description: Name of the Tag being deleted. This value must be URL-encoded.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Tag deleted successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid tagName:
                  summary: Invalid tagName
                  description: Invalid tagName
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid tagName 'INVALID_TAG_NAME' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}/messages:
    get:
      tags:
      - customer-engagement
      summary: Get messages
      description: Use this method to get a list of messages from a conversation with pagination and filtering option. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters.
      operationId: get-messages
      parameters:
      - name: messageIds
        in: query
        description: Optional. List of messages Ids.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: channel
        in: query
        description: Optional. Message chanel.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - SMS
          - VIBER
          - FACEBOOK_MESSENGER
          - WHATSAPP
          - RCS
          - LIVE_CHAT
          - LINE
          - TELEGRAM
          - INSTAGRAM_MESSAGING
          - KAKAO_SANGDAM
          - VIBER_BOT
          - APPLE_BUSINESS_CHAT
          - EMAIL
      - name: direction
        in: query
        description: Optional. Message direction.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - INBOUND
          - OUTBOUND
      - name: createdAfter
        in: query
        description: 'Optional. Filter results created after specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdBefore
        in: query
        description: 'Optional. Filter results created before specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: 'This parameter is used to order your results.

          If an order is not given, the default order id:asc will be applied.

          Possible ordering fields are properties.

          Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: conversationId
        in: path
        description: Id of the conversation to get messages from.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: time
        numberOfRequests: 500
        numberOfTimeUnits: 0
        timeUnit: m
    post:
      tags:
      - customer-engagement
      summary: Create message
      description: "Inbound messages are automatically threaded in conversations if the channels and senders are configured for using Conversations.\nTo send an outbound message use this method with the following parameters, adding it to an existing conversation.\nPlease note that the response from sending a TEMPLATE content type is a message of the TEXT content type, containing the\ntemplate content filled with parameters. \n\nAlso, HTTP header should contain parameter \"x-agent-id\" as agent identifier,\nbut only in case conversations are assigned to agents. <a href=\"https://www.infobip.com/docs/conversations-api/messages\" target=\"_blank\">More info</a>"
      operationId: create-message
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation to set message for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateMessageApiRequest'
            examples:
              Sending SMS message.:
                summary: Sending SMS message.
                description: Sending SMS message.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: SMS
                  contentType: TEXT
                  content:
                    text: Text content.
              Sending WHATSAPP message with IMAGE content.:
                summary: Sending WHATSAPP message with IMAGE content.
                description: Sending WHATSAPP message with IMAGE content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: IMAGE
                  content:
                    url: https://www.url.com/assets/image.jpg
              Sending WHATSAPP message with LOCATION content.:
                summary: Sending WHATSAPP message with LOCATION content.
                description: Sending WHATSAPP message with LOCATION content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: LOCATION
                  content:
                    longitude: -1.826323
                    latitude: 51.178844
                    locationName: Location
                    address: Address
              Sending VIBER message with LOCATION content.:
                summary: Sending VIBER message with LOCATION content.
                description: Sending VIBER message with LOCATION content.
                value:
                  from: DemoCompany
                  to: '44776333666'
                  channel: VIBER
                  contentType: LOCATION
                  content:
                    longitude: 1.2
                    latitude: 3.4
                    locationName: Location
                    address: Address Name
              Sending WHATSAPP message with DOCUMENT content.:
                summary: Sending WHATSAPP message with DOCUMENT content.
                description: Sending WHATSAPP message with DOCUMENT content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: DOCUMENT
                  content:
                    url: https://www.url.com/assets/document.doc
              Sending WHATSAPP message with VIDEO content.:
                summary: Sending WHATSAPP message with VIDEO content.
                description: Sending WHATSAPP message with VIDEO content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: VIDEO
                  content:
                    url: https://www.url.com/assets/video.avi
              Sending WHATSAPP message with AUDIO content.:
                summary: Sending WHATSAPP message with AUDIO content.
                description: Sending WHATSAPP message with AUDIO content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: AUDIO
                  content:
                    url: https://www.url.com/assets/audio.mp3
              Sending WHATSAPP message with CONTACT content.:
                summary: Sending WHATSAPP message with CONTACT content.
                description: Sending WHATSAPP message with CONTACT content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: CONTACT
                  content:
                    contacts:
                    - name:
                        first_name: First Name
                        last_name: Last Name
                        formatted_name: Formatted First Last Name
                      org:
                        company: Company Name
                      emails:
                      - email: first@last@company.com
                        type: private
                      urls:
                      - url: https://url.com/assets/profile
                        type: PROFILE
                      birthday: '2019-02-18'
                      addresses:
                      - city: City
                        country: Country
                        countryCode: '123'
                        street: Street name
                        type: WORK
                        zip: '12345'
                      phones:
                      - phone: +123 456 789
                        type: Mobile
                        waId: '123456'
                      - phone: +123 456 7890
                        type: Work
              Sending WHATSAPP message with TEMPLATE content.:
                summary: Sending WHATSAPP message with TEMPLATE content.
                description: Sending WHATSAPP message with TEMPLATE content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: TEMPLATE
                  content:
                    templateName: welcome_multiple_languages
                    language: es
                    parameters:
                    - default: Pablo
              Sending WHATSAPP message with TEXT MEDIA TEMPLATE content.:
                summary: Sending WHATSAPP message with TEXT MEDIA TEMPLATE content.
                description: Sending WHATSAPP message with TEXT MEDIA TEMPLATE content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: MEDIA_TEMPLATE
                  content:
                    templateName: text_media_template
                    language: en
                    header:
                      placeholder: Gustavo
                      type: TEXT
                    body:
                      placeholders:
                      - 6-15
                      - 17-19
                    buttons:
                    - parameters:
                      - support
                      type: URL
              Sending WHATSAPP message with INTERACTIVE URL BUTTON content.:
                summary: Sending WHATSAPP message with INTERACTIVE URL BUTTON content.
                description: Sending WHATSAPP message with INTERACTIVE URL BUTTON content.
                value:
                  from: '447123456789'
                  to: '44987654321'
                  channel: WHATSAPP
                  contentType: INTERACTIVE
                  content:
                    interactive:
                      header:
                        text: send reply header text
                        type: IMAGE
                        url: https://www.url.com/assets/image.jpg
                      body:
                        text: send reply body text
                      footer:
                        text: send reply footer text
                      action:
                        buttons:
                        - id: postback 1
                          title: button 1
                          type: BUTTON
                        - id: postback 2
                          title: button 2
                          type: BUTTON
                      type: BUTTON
              Sending WHATSAPP message with INTERACTIVE BUTTONS content.:
                summary: Sending WHATSAPP message with INTERACTIVE BUTTONS content.
                description: Sending WHATSAPP message with INTERACTIVE BUTTONS content.
                value:
                  from: '447123456789'
                  to: '44987654321'
                  channel: WHATSAPP
                  contentType: INTERACTIVE
                  content:
                    interactive:
                      header:
                        text: send reply header text
                        type: TEXT
                      body:
                        text: send reply body text
                      footer:
                        text: send reply footer text
                      action:
                        displayText: display text
                        url: http://localhost:8000
                      type: URL_BUTTON
              Sending WHATSAPP message with INTERACTIVE LIST content.:
                summary: Sending WHATSAPP message with INTERACTIVE LIST content.
                description: Sending WHATSAPP message with INTERACTIVE LIST content.
                value:
                  from: '447123456789'
                  to: '44987654321'
                  channel: WHATSAPP
                  contentType: INTERACTIVE
                  content:
                    interactive:
                      header:
                        text: header text
                        type: TEXT
                      body:
                        text: body text
                      footer:
                        text: footer text
                      action:
                        button: options
                        sections:
                        - title: section1 title
                          rows:
                          - id: row1.1
                            title: title1.1
                            description: description1.1
                          - id: row1.2
                            title: title1.2
                            description: description1.2
                        - title: section2 title
                          rows:
                          - id: row2.1
                            title: title2.1
                            description: description2.1
                      type: LIST
              Sending WHATSAPP message with INTERACTIVE FLOW content.:
                summary: Sending WHATSAPP message with INTERACTIVE FLOW content.
                description: Sending WHATSAPP message with INTERACTIVE FLOW content.
                value:
                  from: '447701408772'
                  to: '420951141432'
                  channel: WHATSAPP
                  contentType: INTERACTIVE
                  content:
                    interactive:
                      header:
                        text: header text
                        type: TEXT
                      body:
                        text: body text
                      footer:
                        text: footer text
                      action:
                        flowActionContent:
                          mode: PUBLISHED
                          messageVersion: 1
                          flowToken: Flow_token
                          flowId: 98E8D4AA79E2693357FAA
                          callToActionButton: start
                          flowAction: DATA_EXCHANGE
                          flowActionPayload:
                            screenId: av4b064a-ca48-45c7-9384-ccf233fd81ee
                            data:
                              data: test
                      type: FLOW
              Sending WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.:
                summary: Sending WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.
                description: Sending WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: MEDIA_TEMPLATE
                  content:
                    templateName: document_media_template
                    language: en
                    header:
                      type: DOCUMENT
                      url: https://www.url.com/assets
                      filename: document.pdf
                    body:
                      placeholders:
                      - 6-15
                      - 17-19
                    buttons:
                    - parameters:
                      - 'yes'
                      type: QUICK_REPLY
                    - parameters:
                      - 'no'
                      type: QUICK_REPLY
              Sending WHATSAPP message with IMAGE MEDIA TEMPLATE content.:
                summary: Sending WHATSAPP message with IMAGE MEDIA TEMPLATE content.
                description: Sending WHATSAPP message with IMAGE MEDIA TEMPLATE content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: MEDIA_TEMPLATE
                  content:
                    templateName: image_media_template
                    language: en
                    header:
                      type: IMAGE
                      url: https://www.url.com/assets/image.jpg
                    body:
                      placeholders:
                      - 6-15
                      - 17-19
                    buttons:
                    - parameters:
                      - 'yes'
                      type: QUICK_REPLY
                    - parameters:
                      - 'no'
                      type: QUICK_REPLY
              Sending WHATSAPP message with LOCATION MEDIA TEMPLATE content.:
                summary: Sending WHATSAPP message with LOCATION MEDIA TEMPLATE content.
                description: Sending WHATSAPP message with LOCATION MEDIA TEMPLATE content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: MEDIA_TEMPLATE
                  content:
                    templateName: location_media_template
                    language: en
                    header:
                      latitude: 45.79359
                      longitude: 15.94613
                      type: LOCATION
                    body:
                      placeholders:
                      - 6-15
                      - 17-19
                    buttons:
                    - parameters:
                      - support
                      type: URL
              Sending WHATSAPP message with VIDEO MEDIA TEMPLATE content.:
                summary: Sending WHATSAPP message with VIDEO MEDIA TEMPLATE content.
                description: Sending WHATSAPP message with VIDEO MEDIA TEMPLATE content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: MEDIA_TEMPLATE
                  content:
                    templateName: video_media_template
                    language: en
                    header:
                      type: VIDEO
                      url: https://www.url.com/assets/video.avi
                    body:
                      placeholders:
                      - 6-15
                      - 17-19
                    buttons:
                    - parameters:
                      - 'yes'
                      type: QUICK_REPLY
                    - parameters:
                      - 'no'
                      type: QUICK_REPLY
              Sending WHATSAPP message with INTERACTIVE PRODUCT content.:
                summary: Sending WHATSAPP message with INTERACTIVE PRODUCT content.
                description: Sending WHATSAPP message with INTERACTIVE PRODUCT content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: WHATSAPP_PRODUCT
                  content:
                    body:
                      text: Test Product 1
                    footer:
                      text: Test footer 1
                    action:
                      catalogId: '123456789'
                      productRetailerId: productRetailerId
              Sending WHATSAPP message with INTERACTIVE MULTI PRODUCT content.:
                summary: Sending WHATSAPP message with INTERACTIVE MULTI PRODUCT content.
                description: Sending WHATSAPP message with INTERACTIVE MULTI PRODUCT content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: WHATSAPP_MULTI_PRODUCT
                  content:
                    header:
                      text: Header multi 1
                    body:
                      text: Test Multi Product 1
                    footer:
                      text: Test multi footer 1
                    action:
                      catalogId: '123456789'
                      sections:
                      - title: section 1
                        productItems:
                        - productRetailerId: retailerId
                        - productRetailerId: productRetailerId
              Sending WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.:
                summary: Sending WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.
                description: Sending WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: INTERACTIVE
                  content:
                    interactive:
                      type: CALL_PERMISSION_REQUEST
              Sending WHATSAPP message with INTERACTIVE VOICE BUTTON content.:
                summary: Sending WHATSAPP message with INTERACTIVE VOICE BUTTON content.
                description: Sending WHATSAPP message with INTERACTIVE VOICE BUTTON content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: INTERACTIVE
                  content:
                    interactive:
                      body:
                        text: body text
                      action:
                        buttonDisplayText: button display text
                      type: VOICE_BUTTON
              Sending WHATSAPP message with INTERACTIVE REQUEST CONTACT INFO BUTTON content.:
                summary: Sending WHATSAPP message with INTERACTIVE REQUEST CONTACT INFO BUTTON content.
                description: Sending WHATSAPP message with INTERACTIVE REQUEST CONTACT INFO BUTTON content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: WHATSAPP
                  contentType: INTERACTIVE
                  content:
                    interactive:
                      body:
                        text: body text
                      type: REQUEST_CONTACT_INFO
              Sending FACEBOOK message with a message tag.:
                summary: Sending FACEBOOK message with a message tag.
                description: Sending FACEBOOK message with a message tag.
                value:
                  from: '113628916991966'
                  to: '4394903220582780'
                  channel: FACEBOOK_MESSENGER
                  contentType: TEXT
                  content:
                    text: Text content
                    tag: ACCOUNT_UPDATE
              Sending FACEBOOK message with IMAGE content.:
                summary: Sending FACEBOOK message with IMAGE content.
                description: Sending FACEBOOK message with IMAGE content.
                value:
                  from: '113628916991966'
                  to: '4394903220582780'
                  channel: FACEBOOK_MESSENGER
                  contentType: IMAGE
                  content:
                    url: https://www.url.com/assets/image.jpg
                    caption: Image caption
              Sending FACEBOOK TEXT message with QUICK REPLIES content.:
                summary: Sending FACEBOOK TEXT message with QUICK REPLIES content.
                description: Sending FACEBOOK TEXT message with QUICK REPLIES content.
                value:
                  from: '113628916991966'
                  to: '4394903220582780'
                  channel: FACEBOOK_MESSENGER
                  contentType: TEXT
                  content:
                    text: test
                    quickReplies:
                    - type: TEXT
                      title: Option 1
                      payload: Payload 1
                    - type: PHONE_NUMBER
                    - type: EMAIL
              Sending FACEBOOK TEMPLATE message with CALL BUTTON content.:
                summary: Sending FACEBOOK TEMPLATE message with CALL BUTTON content.
                description: Sending FACEBOOK TEMPLATE message with CALL BUTTON content.
                value:
                  from: '113628916991966'
                  to: '4394903220582780'
                  channel: FACEBOOK_MESSENGER
                  contentType: FACEBOOK_TEMPLATE
                  content:
                    payload:
                      type: BUTTON
                      text: payload
                      buttons:
                      - title: title
                        payload: '+123456789'
                        type: CALL
              Sending FACEBOOK TEMPLATE message with URL BUTTON content.:
                summary: Sending FACEBOOK TEMPLATE message with URL BUTTON content.
                description: Sending FACEBOOK TEMPLATE message with URL BUTTON content.
                value:
                  from: '113628916991966'
                  to: '4394903220582780'
                  channel: FACEBOOK_MESSENGER
                  contentType: FACEBOOK_TEMPLATE
                  content:
                    payload:
                      type: BUTTON
                      text: payload
                      buttons:
                      - title: URL Button title
                        url: https://www.url.com/assets/url
                        type: URL
              Sending FACEBOOK TEMPLATE message with POSTBACK BUTTON content.:
                summary: Sending FACEBOOK TEMPLATE message with POSTBACK BUTTON content.
                description: Sending FACEBOOK TEMPLATE message with POSTBACK BUTTON content.
                value:
                  from: '113628916991966'
                  to: '4394903220582780'
                  channel: FACEBOOK_MESSENGER
                  contentType: FACEBOOK_TEMPLATE
                  content:
                    payload:
                      type: BUTTON
                      text: payload
                      buttons:
                      - title: 'Yes'
                        payload: 'Yes'
                        type: POSTBACK
                      - title: 'No'
                        payload: 'No'
                        type: POSTBACK
              Sending FACEBOOK message with GENERIC TEMPLATE content.:
                summary: Sending FACEBOOK message with GENERIC TEMPLATE content.
                description: Sending FACEBOOK message with GENERIC TEMPLATE content.
                value:
                  from: '113628916991966'
                  to: '4394903220582780'
                  channel: FACEBOOK_MESSENGER
                  contentType: FACEBOOK_TEMPLATE
                  content:
                    payload:
                      type: GENERIC
                      text: payload
                      elements:
                      - title: Title 1
                        subtitle: Subtitle 1
                        imageUrl: https://www.url.com/assets/image1.jpg
                        defaultAction: https://www.url.com/assets/action1
                        buttons:
                        - title: title
                          payload: '+123456789'
                          type: CALL
                      - title: Title 2
                        subtitle: Subtitle 2
                        imageUrl: https://www.url.com/assets/image2.jpg
                        defaultAction: https://www.url.com/assets/action2
              Sending FACEBOOK TEXT message as a reply to Facebook comment.:
                summary: Sending FACEBOOK TEXT message as a reply to Facebook comment.
                description: Sending FACEBOOK TEXT message as a reply to Facebook comment.
                value:
                  from: '113628916991966'
                  to: '4394903220582780'
                  channel: FACEBOOK_MESSENGER
                  contentType: PRIVATE_REPLY_TO_SOCIAL_COMMENT
                  content:
                    externalMessageId: '123456789'
                    contentType: TEXT
                    content:
                      text: Hello, how can I help you?
              Sending FACEBOOK POST TEXT message as a reply to Facebook comment.:
                summary: Sending FACEBOOK POST TEXT message as a reply to Facebook comment.
                description: Sending FACEBOOK POST TEXT message as a reply to Facebook comment.
                value:
                  from: '342927978961470'
                  to: '8278368984819644'
                  channel: FACEBOOK_POST
                  contentType: TEXT
                  content:
                    text: This is a text example for message send via API.
              Sending FACEBOOK POST TEXT message with mentions as a reply to Facebook comment.:
                summary: Sending FACEBOOK POST TEXT message with mentions as a reply to Facebook comment.
                description: Sending FACEBOOK POST TEXT message with mentions as a reply to Facebook comment.
                value:
                  from: '342927978961470'
                  to: '8278368984819644'
                  channel: FACEBOOK_POST
                  contentType: TEXT
                  content:
                    socialMentions:
                    - startPosition: 0
                      endPosition: 9
                      userExternalId: '151848451515'
                    text: '@John.Doe This is a text example for message send via API.'
              Sending INSTAGRAM POST TEXT message as a reply to Facebook comment.:
                summary: Sending INSTAGRAM POST TEXT message as a reply to Facebook comment.
                description: Sending INSTAGRAM POST TEXT message as a reply to Facebook comment.
                value:
                  from: '342927978141470'
                  to: '8278368984819678'
                  channel: INSTAGRAM_POST
                  contentType: TEXT
                  content:
                    text: This is a text example for message send via API.
              Sending INSTAGRAM POST TEXT message with mentions as a reply to Instagram comment.:
                summary: Sending INSTAGRAM POST TEXT message with mentions as a reply to Instagram comment.
                description: Sending INSTAGRAM POST TEXT message with mentions as a reply to Instagram comment.
                value:
                  from: '342927978141470'
                  to: '8278368984819678'
                  channel: INSTAGRAM_POST
                  contentType: TEXT
                  content:
                    socialMentions:
                    - startPosition: 0
                      endPosition: 9
                      userExternalId: john.doe
                    text: '@John.Doe This is a text example for message send via API.'
              Sending LIVE CHAT message with TEXT content.:
                summary: Sending LIVE CHAT message with TEXT content.
                description: Sending LIVE CHAT message with TEXT content.
                value:
                  from: LiveChatSender
                  to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                  channel: LIVE_CHAT
                  contentType: TEXT
                  content:
                    text: Text content.
              Sending LIVE CHAT message with LC_QUICK_REPLY content.:
                summary: Sending LIVE CHAT message with LC_QUICK_REPLY content.
                description: Sending LIVE CHAT message with LC_QUICK_REPLY content.
                value:
                  from: LiveChatSender
                  to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                  channel: LIVE_CHAT
                  contentType: LC_QUICK_REPLY
                  content:
                    suggestedReplies:
                    - 'Yes'
                    - 'No'
                    sourceType: TEXT
                    source:
                      text: Ready to ask?
              Sending LIVE CHAT message with BUTTON content.:
                summary: Sending LIVE CHAT message with BUTTON content.
                description: Sending LIVE CHAT message with BUTTON content.
                value:
                  from: LiveChatSender
                  to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                  channel: LIVE_CHAT
                  contentType: BUTTON
                  content:
                    buttonType: LIVECHAT
                    button:
                      text: 'Try options below:'
                      buttonPayloads:
                      - title: 'Yes'
                        type: POSTBACK
                        payload: 'Yes'
                      - title: 'No'
                        type: POSTBACK
                        payload: 'No'
                      - title: Google
                        type: URL
                        payload: https://google.com
              Sending LIVE CHAT message with VIDEO content.:
                summary: Sending LIVE CHAT message with VIDEO content.
                description: Sending LIVE CHAT message with VIDEO content.
                value:
                  from: LiveChatSender
                  to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                  channel: LIVE_CHAT
                  contentType: VIDEO
                  content:
                    caption: null
                    url: https://www.url.com/assets/video.avi
              Sending LIVE CHAT message with IMAGE content.:
                summary: Sending LIVE CHAT message with IMAGE content.
                description: Sending LIVE CHAT message with IMAGE content.
                value:
                  from: LiveChatSender
                  to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                  channel: LIVE_CHAT
                  contentType: IMAGE
                  content:
                    caption: null
                    url: https://www.url.com/assets/image.jpg
              Sending LIVE CHAT message with DOCUMENT content.:
                summary: Sending LIVE CHAT message with DOCUMENT content.
                description: Sending LIVE CHAT message with DOCUMENT content.
                value:
                  from: LiveChatSender
                  to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                  channel: LIVE_CHAT
                  contentType: DOCUMENT
                  content:
                    caption: null
                    url: https://www.url.com/assets/document.doc
              Sending LIVE CHAT message with LC_CAROUSEL content.:
                summary: Sending LIVE CHAT message with LC_CAROUSEL content.
                description: Sending LIVE CHAT message with LC_CAROUSEL content.
                value:
                  from: LiveChatSender
                  to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                  channel: LIVE_CHAT
                  contentType: LC_CAROUSEL
                  content:
                    cards:
                    - title: Card title
                      description: Card description
                      imageUrl: https://image.url
                      cardActions:
                      - title: Open URL
                        postbackData: https://open.url
                        type: URL
                      - title: Send postback data
                        postbackData: data-to-send
                        type: POSTBACK_DATA
                    - title: Card title
                      description: Card description
                      imageUrl: https://image.url
                      cardActions:
                      - title: Open URL
                        postbackData: https://open.url
                        type: URL
                      - title: Send postback data
                        postbackData: data-to-send
                        type: POSTBACK_DATA
              Sending LIVE CHAT message with LC_CAROUSEL message with QUICK REPLIES content.:
                summary: Sending LIVE CHAT message with LC_CAROUSEL message with QUICK REPLIES content.
                description: Sending LIVE CHAT message with LC_CAROUSEL message with QUICK REPLIES content.
                value:
                  from: LiveChatSender
                  to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                  channel: LIVE_CHAT
                  contentType: LC_CAROUSEL
                  content:
                    cards:
                    - title: Card title
                      description: Card description
                      imageUrl: https://image.url
                      cardActions:
                      - title: Open URL
                        postbackData: https://open.url
                        type: URL
                      - title: Send postback data
                        postbackData: data-to-send
                        type: POSTBACK_DATA
                    - title: Card title
                      description: Card description
                      imageUrl: https://image.url
                      cardActions:
                      - title: Open URL
                        postbackData: https://open.url
                        type: URL
                      - title: Send postback data
                        postbackData: data-to-send
                        type: POSTBACK_DATA
                    quickReplies:
                    - quick
                    - replies
              Sending LIVE CHAT message with CUSTOM_DATA content.:
                summary: Sending LIVE CHAT message with CUSTOM_DATA content.
                description: Sending LIVE CHAT message with CUSTOM_DATA content.
                value:
                  from: c7c43fc4-0117-49c4-a1a3-2a527f413649
                  to: 57d2edb7-e64f-410c-90ec-f88c0ad59fd0
                  channel: LIVE_CHAT
                  contentType: CUSTOM_DATA
                  content:
                    agentMessage: Message to be displayed to the agent.
                    userMessage: Message to be displayed to the user.
                    customData:
                      key1: value1
                      key2: value2
              Sending TELEGRAM message with IMAGE content.:
                summary: Sending TELEGRAM message with IMAGE content.
                description: Sending TELEGRAM message with IMAGE content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: TELEGRAM
                  contentType: IMAGE
                  content:
                    url: https://www.url.com/assets
                    caption: image.jpg
              Sending TELEGRAM TEXT message with REPLY BUTTON content.:
                summary: Sending TELEGRAM TEXT message with REPLY BUTTON content.
                description: Sending TELEGRAM TEXT message with REPLY BUTTON content.
                value:
                  from: '1234567890'
                  to: 0987654321
                  channel: TELEGRAM
                  contentType: TEXT
                  content:
                    text: Please share your contact data.
                    replyMarkup:
                      keyboard:
                      - - text: Share contact information
                          type: TEXT_WITH_CONTACT
                      resizeKeyboard: true
                      oneTimeKeyboard: true
                      selective: false
                      input_field_placeholder: Placeholder text
                      type: REPLY_KEYBOARD_MARKUP_V2
              Sending VIBER BOT TEXT message with KEYBOARD content.:
                summary: Sending VIBER BOT TEXT message with KEYBOARD content.
                description: Sending VIBER BOT TEXT message with KEYBOARD content.
                value:
                  from: pa:5555160884103864311
                  to: qTj/1PNa1/G8TUWwQBaRVA==
                  channel: VIBER_BOT
                  contentType: TEXT
                  content:
                    text: hello world
                    keyboard:
                      backgroundColor: '#333333'
                      actionBarState: HIDDEN
                      buttonGrid:
                        buttonsGroupColumns: 6
                        buttonsGroupRows: 4
                        buttons:
                        - action:
                            actionBody: Button postback 1
                            actionType: REPLY
                          columns: 6
                          rows: 1
                          text:
                            text: Button 1
                          background:
                            color: '#00ffff'
                        - action:
                            actionBody: Button postback 2
                            actionType: REPLY
                          columns: 6
                          rows: 2
                          text:
                            text: Button 2
                          background:
                            color: '#00ff00'
                        - action:
                            actionBody: Button postback 3
                            actionType: REPLY
                          columns: 6
                          rows: 1
                          text:
                            text: Button 3
                          background:
                            color: '#ffff80'
              Sending VIBER BOT message with IMAGE content.:
                summary: Sending VIBER BOT message with IMAGE content.
                description: Sending VIBER BOT message with IMAGE content.
                value:
                  from: pa:5555160884103864311
                  to: qTj/1PNa1/G8TUWwQBaRVA==
                  channel: VIBER_BOT
                  contentType: IMAGE
                  content:
                    url: https://www.url.com/assets/image.jpg
              Sending VIBER BOT message with VIDEO content.:
                summary: Sending VIBER BOT message with VIDEO content.
                description: Sending VIBER BOT message with VIDEO content.
                value:
                  from: pa:5555160884103864311
                  to: qTj/1PNa1/G8TUWwQBaRVA==
                  channel: VIBER_BOT
                  contentType: VIBER_BOT_VIDEO
                  content:
                    url: https://www.url.com/assets/video.avi
                    size: '1500'
              Sending VIBER BOT message with CONTACT content.:
                summary: Sending VIBER BOT message with CONTACT content.
                description: Sending VIBER BOT message with CONTACT content.
                value:
                  from: pa:5555160884103864311
                  to: qTj/1PNa1/G8TUWwQBaRVA==
                  channel: VIBER_BOT
                  contentType: CONTACT
                  content:
                    contacts:
                    - name:
                        firstName: Infobip
                        formattedName: Infobip
                      phones:
                      - phone: '123456'
                        type: CELL
                        waId: '123456'
                      emails:
                      - email: email@infobip.com
                        type: EMAIL
              Sending VIBER BOT message with LOCATION content.:
                summary: Sending VIBER BOT message with LOCATION content.
                description: Sending VIBER BOT message with LOCATION content.
                value:
                  from: pa:5555160884103864311
                  to: qTj/1PNa1/G8TUWwQBaRVA==
                  channel: VIBER_BOT
                  contentType: LOCATION
                  content:
                    latitude: 44.953
                    longitude: 13.8564
              Sending VIBER BOT message with CAROUSEL content.:
                summary: Sending VIBER BOT message with CAROUSEL content.
                description: Sending VIBER BOT message with CAROUSEL content.
                value:
                  from: pa:5555160884103864311
                  to: qTj/1PNa1/G8TUWwQBaRVA==
                  channel: VIBER_BOT
                  contentType: VIBER_BOT_CAROUSEL
                  content:
                    heightScale: 100
                    buttonGrid:
                      buttonsGroupColumns: 3
                      buttonsGroupRows: 4
                      buttons:
                      - columns: 3
                        rows: 2
                        media:
                          imageUrl: https://url.com/assets/image1.png
                          imageScaleType: FIT
                        action:
                          actionBody: image 1 clicked
                          actionType: REPLY
                      - columns: 3
                        rows: 1
                        text:
                          text: Example 1
                          size: LARGE
                          horizontalAlign: CENTER
                          verticalAlign: MIDDLE
                        action:
                          actionBody: Example 1 clicked
                          actionType: REPLY
                      - columns: 3
                        rows: 1
                        text:
                          text: Buy this one
                        background:
                          color: '#ff0000'
                          frame:
                            cornerRadius: 4
                        action:
                          actionBody: Buy Example 1
                          actionType: REPLY
                      - columns: 3
                        rows: 2
                        media:
                          imageUrl: https://url.com/assets/image2.png
                          imageScaleType: CROP
                        action:
                          actionBody: image 2 clicked
                          actionType: REPLY
                      - columns: 3
                        rows: 1
                        text:
                          text: Example 2
                          size: LARGE
                          horizontalAlign: CENTER
                          verticalAlign: MIDDLE
                        action:
                          actionBody: Example 2 clicked
                          actionType: REPLY
                      - columns: 3
                        rows: 1
                        text:
                          text: Buy this one
                        background:
                          color: '#ff0000'
                          frame:
                            cornerRadius: 4
                        action:
                          actionBody: Buy Example 2
                          actionType: REPLY
                      - columns: 3
                        rows: 2
                        media:
                          imageUrl: https://url.com/assets/image3.png
                          imageScaleType: FIT
                        action:
                          actionBody: image 3 clicked
                          actionType: REPLY
                      - columns: 3
                        rows: 1
                        text:
                          text: Example 3
                          size: LARGE
                          horizontalAlign: CENTER
                          verticalAlign: MIDDLE
                        action:
                          actionBody: Example 3 clicked
                          actionType: REPLY
                      - columns: 3
                        rows: 1
                        text:
                          text: Buy this one
                        background:
                          color: '#ff0000'
                          frame:
                            cornerRadius: 4
                        action:
                          actionBody: Buy Example 3
                          actionType: REPLY
                      - columns: 3
                        rows: 2
                        media:
                          imageUrl: https://url.com/assets/image4.png
                        action:
                          actionBody: image 4 clicked
                          actionType: REPLY
                      - columns: 3
                        rows: 1
                        text:
                          text: Example 4
                          size: LARGE
                          horizontalAlign: CENTER
                          verticalAlign: MIDDLE
                        action:
                          actionBody: Example 4 clicked
                          actionType: REPLY
                      - columns: 3
                        rows: 1
                        text:
                          text: Buy this one
                        action:
                          actionBody: Buy Example 4
                          actionType: REPLY
                    fromDetails:
                      name: Example Name
              Sending INSTAGRAM MESSAGING message with TEMPLATE content.:
                summary: Sending INSTAGRAM MESSAGING message with TEMPLATE content.
                description: Sending INSTAGRAM MESSAGING message with TEMPLATE content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: INSTAGRAM_MESSAGING
                  contentType: INSTAGRAM_TEMPLATE
                  content:
                    payload:
                      elements:
                      - title: title 1
                        subtitle: subtitle
                        imageUrl: https://url.com/assets/image1.png
                        defaultAction:
                          url: https://url.com/assets/profile1/default
                        buttons:
                        - title: Title
                          payload: https://url.com/assets/buttons1.png
                          type: URL
                        - title: button postback
                          payload: payload
                          type: POSTBACK
                      - title: title 2
                        subtitle: subtitle
                        imageUrl: https://url.com/assets/image2.png
                        defaultAction:
                          url: https://url.com/assets/profile2/default
                        buttons:
                        - title: button postback 2
                          payload: payload 2
                          type: POSTBACK
                      type: GENERIC
              Sending INSTAGRAM MESSAGING message with TEXT content.:
                summary: Sending INSTAGRAM MESSAGING message with TEXT content.
                description: Sending INSTAGRAM MESSAGING message with TEXT content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: INSTAGRAM_MESSAGING
                  contentType: TEXT
                  content:
                    text: What type of services do you specialise in?
              Sending INSTAGRAM MESSAGING message with IMAGE content.:
                summary: Sending INSTAGRAM MESSAGING message with IMAGE content.
                description: Sending INSTAGRAM MESSAGING message with IMAGE content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: INSTAGRAM_MESSAGING
                  contentType: IMAGE
                  content:
                    url: https://www.url.com/assets/image.jpg
              Sending INSTAGRAM MESSAGING message with INSTAGRAM_STICKER content.:
                summary: Sending INSTAGRAM MESSAGING message with INSTAGRAM_STICKER content.
                description: Sending INSTAGRAM MESSAGING message with INSTAGRAM_STICKER content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: INSTAGRAM_MESSAGING
                  contentType: INSTAGRAM_STICKER
                  content:
                    sticker: like_heart
              Sending INSTAGRAM MESSAGING message with QUICK REPLIES content.:
                summary: Sending INSTAGRAM MESSAGING message with QUICK REPLIES content.
                description: Sending INSTAGRAM MESSAGING message with QUICK REPLIES content.
                value:
                  from: '447492263897'
                  to: '44776333666'
                  channel: INSTAGRAM_MESSAGING
                  contentType: TEXT
                  content:
                    text: test
                    quickReplies:
                    - type: TEXT
                      title: Option 1
                      payload: Payload 1
                    - type: PHONE_NUMBER
                    - type: EMAIL
              Sending LINE TEMPLATE message with BUTTONS content.:
                summary: Sending LINE TEMPLATE message with BUTTONS content.
                description: Sending LINE TEMPLATE message with BUTTONS content.
                value:
                  from: '1654088914'
                  to: Ud1c123456789abcd12345efd7aa01234
                  channel: LINE
                  contentType: LINE_TEMPLATE
                  content:
                    type: LINE_TEMPLATE
                    altText: Buttons template with custom actions
                    template:
                      type: BUTTONS
                      thumbnailImageUrl: https://url.com/assets/image.png
                      imageAspectRatio: RECTANGLE
                      imageSize: COVER
                      imageBackgroundColor: '#FFFFFF'
                      title: Payload title
                      text: Payload text
                      defaultAction:
                        type: URI
                        label: Example uri action
                        uri: https://url.com/assets/defaults/action
                      actions:
                      - type: URI
                        label: URI action
                        uri: https://url.com/assets/action1
                      - type: DATETIMEPICKER
                        label: Picker action
                        data: Action data
                        mode: DATETIME
                        min: 2024-01-01T00:00
                        max: 2024-12-01T00:00
                      - type: POSTBACK
                        label: Postback action
                        data: action=buy&itemid=123
              Sending LINE TEMPLATE message with CAROUSEL content.:
                summary: Sending LINE TEMPLATE message with CAROUSEL content.
                description: Sending LINE TEMPLATE message with CAROUSEL content.
                value:
                  from: '1654088914'
                  to: Ud1c123456789abcd12345efd7aa01234
                  channel: LINE
                  contentType: LINE_TEMPLATE
                  content:
                    altText: Carousel template with custom actions
                    template:
                      type: CAROUSEL
                      imageAspectRatio: SQUARE
                      imageSize: CONTAIN
                      columns:
                      - thumbnailImageUrl: https://url.com/assets/image1.png
                        imageBackgroundColor: '#FFFFFF'
                        title: Column 1 title
                        text: Column 1 text
                        defaultAction:
                          type: URI
                          label: View detail 1
                          uri: https://url.com/assets/defaults/action1
                        actions:
                        - type: URI
                          label: View detail 1
                          uri: https://url.com/assets/action1
                        - type: POSTBACK
                          label: Buy item 1
                          data: action=buy&itemid=1
                      - thumbnailImageUrl: https://url.com/assets/image2.png
                        imageBackgroundColor: '#BBBBBB'
                        title: Column 2 title
                        text: Column 2 text
                        defaultAction:
                          type: URI
                          label: View detail 2
                          uri: https://url.com/assets/defaults/action2
                        actions:
                        - type: URI
                          label: View detail 2
                          uri: https://url.com/assets/action2
                        - type: POSTBACK
                          label: Buy item 2
                          data: action=buy&itemid=2
              Sending APPLE BUSINESS CHAT message with TEXT content.:
                summary: Sending APPLE BUSINESS CHAT message with TEXT content.
                description: Sending APPLE BUSINESS CHAT message with TEXT content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: TEXT
                  content:
                    text: This is a text example for Apple Business Chat.
              Sending APPLE BUSINESS CHAT message with IMAGE content.:
                summary: Sending APPLE BUSINESS CHAT message with IMAGE content.
                description: Sending APPLE BUSINESS CHAT message with IMAGE content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: IMAGE
                  content:
                    url: https://www.url.com/assets/image.jpg
              Sending APPLE BUSINESS CHAT message with LOCATION content.:
                summary: Sending APPLE BUSINESS CHAT message with LOCATION content.
                description: Sending APPLE BUSINESS CHAT message with LOCATION content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: LOCATION
                  content:
                    latitude: -12.34
                    longitude: 34.56
                    locationName: Location Name
                    address: Address Name
              Sending APPLE BUSINESS CHAT message with VIDEO content.:
                summary: Sending APPLE BUSINESS CHAT message with VIDEO content.
                description: Sending APPLE BUSINESS CHAT message with VIDEO content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: VIDEO
                  content:
                    url: https://www.url.com/assets/video.avi
              Sending APPLE BUSINESS CHAT message with DOCUMENT content.:
                summary: Sending APPLE BUSINESS CHAT message with DOCUMENT content.
                description: Sending APPLE BUSINESS CHAT message with DOCUMENT content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: DOCUMENT
                  content:
                    url: https://www.url.com/assets/document.doc
              Sending APPLE BUSINESS CHAT message with LIST_PICKER content.:
                summary: Sending APPLE BUSINESS CHAT message with LIST_PICKER content.
                description: Sending APPLE BUSINESS CHAT message with LIST_PICKER content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: LIST_PICKER
                  content:
                    images:
                    - imageUrl: https://www.url.com/assets/image1.jpg
                      identifier: item1ImageIdentifier1
                    - imageUrl: https://www.url.com/assets/image2.jpg
                      identifier: item1ImageIdentifier2
                    - imageUrl: https://www.url.com/assets/image3.jpg
                      identifier: item2ImageIdentifier1
                    - imageUrl: https://www.url.com/assets/image4.jpg
                      identifier: item2ImageIdentifier2
                    appleListPicker:
                      sections:
                      - items:
                        - identifier: item1Identifier1
                          imageIdentifier: item1ImageIdentifier1
                          order: 0
                          style: icon
                          subtitle: item1Subtitle1
                          title: item1Title1
                        - identifier: item1Identifier2
                          imageIdentifier: item1ImageIdentifier2
                          order: 1
                          style: icon
                          subtitle: item1Subtitle2
                          title: item1Title2
                        order: 0
                        title: sectionTitle1
                        multipleSelection: false
                      - items:
                        - identifier: item2Identifier1
                          imageIdentifier: item2ImageIdentifier1
                          order: 0
                          style: icon
                          subtitle: item2Subtitle1
                          title: item2Title1
                        - identifier: item2Identifier2
                          imageIdentifier: item2ImageIdentifier2
                          order: 1
                          style: icon
                          subtitle: item2Subtitle2
                          title: item2Title2
                        order: 1
                        title: sectionTitle2
                        multipleSelection: true
                    requestIdentifier: requestIdentifier1
                    receivedMessage:
                      style: icon
                      title: receivedMessageTitle
                      subtitle: receivedMessageSubtitle
                      imageIdentifier: receivedMessageImageIdentifier
                    replyMessage:
                      style: small
                      title: replyMessageTitle
                      subtitle: replyMessageSubtitle
                      imageIdentifier: replyMessageImageIdentifier
              Sending APPLE BUSINESS CHAT message with RICH_LINK content.:
                summary: Sending APPLE BUSINESS CHAT message with RICH_LINK content.
                description: Sending APPLE BUSINESS CHAT message with RICH_LINK content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: RICH_LINK
                  content:
                    linkUrl: https://www.url.com/assets/link
                    linkTitle: Title
                    imageUrl: https://www.url.com/assets/image.jpg
                    videoUrl: https://www.url.com/assets/video.avi
              Sending APPLE BUSINESS CHAT message with TIME_PICKER content.:
                summary: Sending APPLE BUSINESS CHAT message with TIME_PICKER content.
                description: Sending APPLE BUSINESS CHAT message with TIME_PICKER content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: TIME_PICKER
                  content:
                    images:
                    - imageUrl: https://www.url.com/assets/image1.jpg
                      identifier: imageIdentifier1
                    - imageUrl: https://www.url.com/assets/image2.jpg
                      identifier: imageIdentifier2
                    event:
                      identifier: eventIdentifier
                      title: eventTitle
                      timeslots:
                      - duration: 12
                        startTime: 1662045024085
                        identifier: timeslotIdentifier1
                      - duration: 13
                        startTime: 1662045024086
                        identifier: timeslotIdentifier2
                      locationItem:
                        latitude: 1.23
                        longitude: 4.56
                        radius: 7.89
                        title: locationItemTitle
                      imageIdentifier: imageIdentifier
                      timezoneOffset: 1
                    requestIdentifier: requestIdentifier1
                    receivedMessage:
                      style: icon
                      title: receivedMessageTitle
                      subtitle: receivedMessageSubtitle
                      imageIdentifier: receivedMessageImageIdentifier
                    replyMessage:
                      style: small
                      title: replyMessageTitle
                      subtitle: replyMessageSubtitle
                      imageIdentifier: replyMessageImageIdentifier
              Sending APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT content.:
                summary: Sending APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT content.
                description: Sending APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: APPLE_QUICK_REPLY_CONTENT
                  content:
                    quickReply:
                      summary: quick reply summary
                      items:
                      - identifier: quickReplyItem1Identifier
                        title: quickReplyItem1Title
                      - identifier: quickReplyItem2Identifier
                        title: quickReplyItem2Title
                    requestIdentifier: requestIdentifier1
              Sending APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT content.:
                summary: Sending APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT content.
                description: Sending APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: APPLE_FORM_CONTENT
                  content:
                    data:
                      pages:
                      - type: DATE_PICKER
                        pageIdentifier: page1Identifier
                        subtitle: page1Subtitle
                        nextPageIdentifier: page1NextIdentifier
                        title: page1Title
                        submitForm: true
                        options:
                          dateFormat: UTF-8
                          startDate: '2022-08-15'
                          maximumDate: '2022-08-01'
                          minimumDate: '2022-08-31'
                          labelText: datePickerLabelText
                      - type: INPUT
                        pageIdentifier: page2Identifier
                        subtitle: page2Subtitle
                        nextPageIdentifier: page2NextIdentifier
                        title: page2Title
                        submitForm: true
                        hintText: page2HintText
                        options:
                          regex: inputRegex
                          placeholder: inputPlaceholder
                          required: true
                          inputType: multiline
                          labelText: inputLabelText
                          prefixText: inputLabelPrefixText
                          maximumCharacterCount: 1
                          keyboardType: namePhonePad
                          appleTextContentType: namePrefix
                      - type: PICKER
                        items:
                        - title: item1Title
                          value: item1Value
                          identifier: item1Identifier
                        - title: item2Title
                          value: item2Value
                          identifier: item2Identifier
                        pageIdentifier: page3Identifier
                        subtitle: page3Subtitle
                        nextPageIdentifier: page3NextIdentifier
                        title: page3Title
                        submitForm: false
                        pickerTitle: page3PickerTitle
                        selectedItemIndex: 2
                      - type: SELECT
                        items:
                        - identifier: item1Identifier
                          title: item1Title
                          value: item1Value
                          nextPageIdentifier: item1NextIdentifier
                          imageIdentifier: item1ImageIdentifier
                        - identifier: item2Identifier
                          title: item2Title
                          value: item2Value
                          nextPageIdentifier: item2NextIdentifier
                          imageIdentifier: item2ImageIdentifier
                        pageIdentifier: page4Identifier
                        subtitle: page4Subtitle
                        nextPageIdentifier: page4NextIdentifier
                        title: page4Title
                        submitForm: true
                        multipleSelection: false
                      startPageIdentifier: dataIdentifier
                      splash:
                        buttonTitle: splash button title
                        splashText: splash text
                        header: splash header
                        imageIdentifier: splash image identifier
                      isPrivate: false
                      showSummary: true
                    images:
                    - imageUrl: https://www.url.com/assets/image1.jpg
                      identifier: imageIdentifier1
                    - imageUrl: https://www.url.com/assets/image2.jpg
                      identifier: imageIdentifier2
                    requestIdentifier: requestIdentifier1
                    receivedMessage:
                      style: icon
                      title: receivedMessageTitle
                      subtitle: receivedMessageSubtitle
                      imageIdentifier: receivedMessageImageIdentifier
                    replyMessage:
                      style: small
                      title: replyMessageTitle
                      subtitle: replyMessageSubtitle
                      imageIdentifier: replyMessageImageIdentifier
              Sending APPLE BUSINESS CHAT message with APPLE_PAY_REQUEST_CONTENT content.:
                summary: Sending APPLE BUSINESS CHAT message with APPLE_PAY_REQUEST_CONTENT content.
                description: Sending APPLE BUSINESS CHAT message with APPLE_PAY_REQUEST_CONTENT content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: APPLE_PAY_REQUEST_CONTENT
                  content:
                    images:
                    - imageUrl: url_1
                      identifier: imageIdentifier_1
                    - imageUrl: url_2
                      identifier: imageIdentifier_2
                    receivedMessage:
                      style: SMALL
                      title: title_received
                      subtitle: subtitle_received
                      imageIdentifier: imageIdentifier_1
                    replyMessage:
                      style: SMALL
                      title: title_reply
                      subtitle: subtitle_reply
                      imageIdentifier: imageIdentifier_2
                    lineItems:
                    - label: item1
                      amount: '0.1'
                      type: Pending
                    - label: item2
                      amount: '1.1'
                      type: Final
                    - label: item3
                      amount: '1111000.992'
                      type: Pending
                    total:
                      label: ApplePayLineItem
                      amount: '22.09'
                      type: Pending
                    shippingMethods:
                    - amount: '15.02'
                      detail: shippingMethodDetail1
                      identifier: identifier1
                      label: label1
                    - amount: '20.10'
                      detail: shippingMethodDetail2
                      identifier: identifier2
                      label: label2
                    requestIdentifier: requestIdentifier_1
              Sending APPLE BUSINESS CHAT message with APPLE_AUTH_REQUEST_CONTENT content.:
                summary: Sending APPLE BUSINESS CHAT message with APPLE_AUTH_REQUEST_CONTENT content.
                description: Sending APPLE BUSINESS CHAT message with APPLE_AUTH_REQUEST_CONTENT content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: APPLE_AUTH_REQUEST_CONTENT
                  content:
                    images:
                    - imageUrl: url_1
                      identifier: imageIdentifier_1
                    - imageUrl: url_2
                      identifier: imageIdentifier_2
                    requestIdentifier: requestIdentifier_1
                    receivedMessage:
                      style: SMALL
                      title: title_received
                      subtitle: subtitle_received
                      imageIdentifier: imageIdentifier_1
                    replyMessage:
                      style: SMALL
                      title: title_reply
                      subtitle: subtitle_reply
                      imageIdentifier: imageIdentifier_2
              Sending APPLE BUSINESS CHAT message with APPLE_CUSTOM_INTERACTIVE_CONTENT content.:
                summary: Sending APPLE BUSINESS CHAT message with APPLE_CUSTOM_INTERACTIVE_CONTENT content.
                description: Sending APPLE BUSINESS CHAT message with APPLE_CUSTOM_INTERACTIVE_CONTENT content.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  contentType: APPLE_CUSTOM_INTERACTIVE_CONTENT
                  content:
                    receivedMessage:
                      style: SMALL
                      title: title_received
                      subtitle: subtitle_received
                      imageIdentifier: imageIdentifier_1
                    replyMessage:
                      style: SMALL
                      title: title_reply
                      subtitle: subtitle_reply
                      imageIdentifier: imageIdentifier_2
              Sending EMAIL message with EMAIL html content.:
                summary: Sending EMAIL message with EMAIL html content.
                description: Sending EMAIL message with EMAIL html content.
                value:
                  from: sender@example.com
                  to: toRecipient1@example.com
                  channel: EMAIL
                  contentType: EMAIL
                  content:
                    toAddresses:
                    - toRecipient1@example.com
                    - toRecipient2@example.com
                    ccAddresses:
                    - ccrecipient@example.com
                    bccAddresses:
                    - bccrecipient@example.com
                    subject: Sample Email Subject
                    contentHtml: <html><body>This is a sample email content.</body></html>
              Sending EMAIL message with EMAIL text content.:
                summary: Sending EMAIL message with EMAIL text content.
                description: Sending EMAIL message with EMAIL text content.
                value:
                  from: sender@example.com
                  to: toRecipient1@example.com
                  channel: EMAIL
                  contentType: EMAIL
                  content:
                    toAddresses:
                    - toRecipient1@example.com
                    - toRecipient2@example.com
                    ccAddresses:
                    - ccRecipient@example.com
                    bccAddresses:
                    - bccRecipient@example.com
                    subject: Sample Email Subject
                    contentText: This is a sample of the email content.
              Sending RCS message with TEXT content.:
                summary: Sending RCS message with TEXT content.
                description: Sending RCS message with TEXT content.
                value:
                  from: infobip
                  to: '385989295741'
                  channel: RCS
                  contentType: TEXT
                  content:
                    text: Test reply
              Sending RCS message with FILE content.:
                summary: Sending RCS message with FILE content.
                description: Sending RCS message with FILE content.
                value:
                  from: infobip
                  to: '385989295741'
                  channel: RCS
                  contentType: RCS_FILE
                  content:
                    file:
                      url: https://url.com/assets/document.pdf
                    thumbnail:
                      url: https://url.com/assets/thumbnail.pdf
              Sending RCS message with CARD content.:
                summary: Sending RCS message with CARD content.
                description: Sending RCS message with CARD content.
                value:
                  from: infobip
                  to: '385989295741'
                  channel: RCS
                  contentType: RCS_CARD
                  content:
                    orientation: HORIZONTAL
                    alignment: RIGHT
                    content:
                      title: rcs card title
                      description: rcs card description
                      media:
                        file:
                          url: https://url.com/assets/image1.png
                        thumbnail:
                          url: https://url.com/assets/image2.png
                        height: MEDIUM
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageApiResponse'
              examples:
                Successful response APPLE BUSINESS CHAT message with TEXT.:
                  summary: Successful response APPLE BUSINESS CHAT message with TEXT.
                  description: Successful response APPLE BUSINESS CHAT message with TEXT.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                    to: urn:urnId
                    channel: APPLE_BUSINESS_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: TEXT
                    content:
                      text: This is a text example for Apple Business Chat.
                Successful response APPLE BUSINESS CHAT message with IMAGE.:
                  summary: Successful response APPLE BUSINESS CHAT message with IMAGE.
                  description: Successful response APPLE BUSINESS CHAT message with IMAGE.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                    to: urn:urnId
                    channel: APPLE_BUSINESS_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: IMAGE
                    content:
                      url: https://www.url.com/assets/image.jpg
                Successful response APPLE BUSINESS CHAT message with LOCATION.:
                  summary: Successful response APPLE BUSINESS CHAT message with LOCATION.
                  description: Successful response APPLE BUSINESS CHAT message with LOCATION.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                    to: urn:urnId
                    channel: APPLE_BUSINESS_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: LOCATION
                    content:
                      latitude: -12.34
                      longitude: 34.56
                      locationName: Location Name
                      address: Address Name
                Successful response APPLE BUSINESS CHAT message with VIDEO.:
                  summary: Successful response APPLE BUSINESS CHAT message with VIDEO.
                  description: Successful response APPLE BUSINESS CHAT message with VIDEO.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                    to: urn:urnId
                    channel: APPLE_BUSINESS_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: VIDEO
                    content:
                      url: https://www.url.com/assets/video.avi
                Successful response APPLE BUSINESS CHAT message with DOCUMENT.:
                  summary: Successful response APPLE BUSINESS CHAT message with DOCUMENT.
                  description: Successful response APPLE BUSINESS CHAT message with DOCUMENT.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                    to: urn:urnId
                    channel: APPLE_BUSINESS_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: DOCUMENT
                    content:
                      url: https://www.url.com/assets/document.doc
                Successful response APPLE BUSINESS CHAT message with LIST_PICKER.:
                  summary: Successful response APPLE BUSINESS CHAT message with LIST_PICKER.
                  description: Successful response APPLE BUSINESS CHAT message with LIST_PICKER.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                    to: urn:urnId
                    channel: APPLE_BUSINESS_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: LIST_PICKER
                    content:
                      images:
                      - imageUrl: https://www.url.com/assets/image1.jpg
                        identifier: imageIdentifier1
                      - imageUrl: https://www.url.com/assets/image2.jpg
                        identifier: imageIdentifier2
                      appleListPicker:
                        sections:
                        - items:
                          - identifier: item1Identifier1
                            imageIdentifier: item1ImageIdentifier1
                            order: 0
                            style: item1Style1
                            subtitle: item1Subtitle1
                            title: item1Title1
                          - identifier: item1Identifier2
                            imageIdentifier: item1ImageIdentifier2
                            order: 1
                            style: item1Style2
                            subtitle: item1Subtitle2
                            title: item1Title2
                          order: 0
                          title: sectionTitle1
                          multipleSelection: false
                        - items:
                          - identifier: item2Identifier1
                            imageIdentifier: item2ImageIdentifier1
                            order: 0
                            style: item2Style1
                            subtitle: item2Subtitle1
                            title: item2Title1
                          - identifier: item2Identifier2
                            imageIdentifier: item2ImageIdentifier2
                            order: 1
                            style: item2Style2
                            subtitle: item2Subtitle2
                            title: item2Title2
                          order: 1
                          title: sectionTitle2
                          multipleSelection: true
                      requestIdentifier: requestIdentifier1
                      receivedMessage:
                        style: icon
                        title: receivedMessageTitle
                        subtitle: receivedMessageSubtitle
                        imageIdentifier: receivedMessageImageIdentifier
                      replyMessage:
                        style: small
                        title: replyMessageTitle
                        subtitle: replyMessageSubtitle
                        imageIdentifier: replyMessageImageIdentifier
                Successful response APPLE BUSINESS CHAT message with RICH_LINK.:
                  summary: Successful response APPLE BUSINESS CHAT message with RICH_LINK.
                  description: Successful response APPLE BUSINESS CHAT message with RICH_LINK.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                    to: urn:urnId
                    channel: APPLE_BUSINESS_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: RICH_LINK
                    content:
                      linkUrl: https://www.url.com/assets/link
                      linkTitle: Title
                      imageUrl: https://www.url.com/assets/image.jpg
                      videoUrl: https://www.url.com/assets/video.avi
                Successful response APPLE BUSINESS CHAT message with TIME_PICKER.:
                  summary: Successful response APPLE BUSINESS CHAT message with TIME_PICKER.
                  description: Successful response APPLE BUSINESS CHAT message with TIME_PICKER.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                    to: urn:urnId
                    channel: APPLE_BUSINESS_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: TIME_PICKER
                    content:
                      images:
                      - imageUrl: https://www.url.com/assets/image1.jpg
                        identifier: imageIdentifier1
                      - imageUrl: https://www.url.com/assets/image2.jpg
                        identifier: imageIdentifier2
                      event:
                        identifier: eventIdentifier
                        title: eventTitle
                        timeslots:
                        - duration: 12
                          startTime: '2022-09-01T15:10:24.085Z'
                          identifier: timeslotIdentifier1
                        - duration: 13
                          startTime: '2022-09-01T15:10:24.086Z'
                          identifier: timeslotIdentifier2
                        locationItem:
                          latitude: 1.23
                          longitude: 4.56
                          radius: 7.89
                          title: locationItemTitle
                        imageIdentifier: imageIdentifier
                        timezoneOffset: 1
                      requestIdentifier: requestIdentifier1
                      receivedMessage:
                        style: icon
                        title: receivedMessageTitle
                        subtitle: receivedMessageSubtitle
                        imageIdentifier: receivedMessageImageIdentifier
                      replyMessage:
                        style: small
                        title: replyMessageTitle
                        subtitle: replyMessageSubtitle
                        imageIdentifier: replyMessageImageIdentifier
                Successful response APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT.:
                  summary: Successful response APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT.
                  description: Successful response APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                    to: urn:urnId
                    channel: APPLE_BUSINESS_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: TIME_PICKER
                    content:
                      quickReply:
                        summaryText: null
                        items:
                        - identifier: quickReplyItem1Identifier
                          title: quickReplyItem1Title
                        - identifier: quickReplyItem2Identifier
                          title: quickReplyItem2Title
                      requestIdentifier: requestIdentifier1
                Successful response APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT.:
                  summary: Successful response APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT.
                  description: Successful response APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                    to: urn:urnId
                    channel: APPLE_BUSINESS_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: APPLE_FORM_CONTENT
                    content:
                      data:
                        pages:
                        - pageIdentifier: page1Identifier
                          subtitle: page1Subtitle
                          nextPageIdentifier: page1NextIdentifier
                          title: page1Title
                          submitForm: true
                          options:
                            dateFormat: UTF-8
                            startDate: '2022-08-15'
                            maximumDate: '2022-08-01'
                            minimumDate: '2022-08-31'
                            labelText: datePickerLabelText
                          type: DATE_PICKER
                        - pageIdentifier: page2Identifier
                          subtitle: page2Subtitle
                          nextPageIdentifier: page2NextIdentifier
                          title: page2Title
                          submitForm: true
                          hintText: page2HintText
                          options:
                            regex: inputRegex
                            placeholder: inputPlaceholder
                            required: true
                            inputType: multiline
                            labelText: inputLabelText
                            prefixText: inputLabelPrefixText
                            maximumCharacterCount: 1
                            keyboardType: namePhonePad
                            appleTextContentType: namePrefix
                          type: INPUT
                        - items:
                          - title: item1Title
                            value: item1Value
                            identifier: item1Identifier
                          - title: item2Title
                            value: item2Value
                            identifier: item2Identifier
                          pageIdentifier: page3Identifier
                          subtitle: page3Subtitle
                          nextPageIdentifier: page3NextIdentifier
                          title: page3Title
                          submitForm: false
                          pickerTitle: page3PickerTitle
                          selectedItemIndex: 2
                          type: PICKER
                        - items:
                          - identifier: item1Identifier
                            title: item1Title
                            value: item1Value
                            nextPageIdentifier: item1NextIdentifier
                            imageIdentifier: item1ImageIdentifier
                          - identifier: item2Identifier
                            title: item2Title
                            value: item2Value
                            nextPageIdentifier: item2NextIdentifier
                            imageIdentifier: item2ImageIdentifier
                          pageIdentifier: page4Identifier
                          subtitle: page4Subtitle
                          nextPageIdentifier: page4NextIdentifier
                          title: page4Title
                          submitForm: true
                          multipleSelection: false
                          type: SELECT
                        startPageIdentifier: dataIdentifier
                        splash:
                          buttonTitle: splash button title
                          splashText: splash text
                          header: splash header
                          imageIdentifier: splash image identifier
                        isPrivate: false
                        showSummary: true
                        private: false
                      images:
                      - imageUrl: https://www.url.com/assets/image1.jpg
                        identifier: imageIdentifier1
                      - imageUrl: https://www.url.com/assets/image2.jpg
                        identifier: imageIdentifier2
                      requestIdentifier: requestIdentifier1
                      receivedMessage:
                        style: icon
                        title: receivedMessageTitle
                        subtitle: receivedMessageSubtitle
                        imageIdentifier: receivedMessageImageIdentifier
                      replyMessage:
                        style: small
                        title: replyMessageTitle
                        subtitle: replyMessageSubtitle
                        imageIdentifier: replyMessageImageIdentifier
                Successful response INSTAGRAM MESSAGING message with TEMPLATE.:
                  summary: Successful response INSTAGRAM MESSAGING message with TEMPLATE.
                  description: Successful response INSTAGRAM MESSAGING message with TEMPLATE.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: INSTAGRAM_MESSAGING
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: INSTAGRAM_TEMPLATE
                    content:
                      payload:
                        elements:
                        - title: title 1
                          subtitle: subtitle
                          imageUrl: https://url.com/assets/image1.png
                          defaultAction:
                            url: https://url.com/assets/profile1
                          buttons:
                          - title: Title
                            payload: https://url.com/assets/buttons1.png
                            type: URL
                          - title: button postback
                            payload: payload
                            type: POSTBACK
                        - title: title 2
                          subtitle: subtitle
                          imageUrl: https://url.com/assets/image2.png
                          defaultAction:
                            url: https://url.com/assets/profile2
                          buttons:
                          - title: button postback 2
                            payload: payload 2
                            type: POSTBACK
                        type: GENERIC
                Successful response LINE message buttons TEMPLATE.:
                  summary: Successful response LINE message buttons TEMPLATE.
                  description: Successful response LINE message buttons TEMPLATE.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '1654088914'
                    to: Ud1c123456789abcd12345efd7aa01234
                    channel: LINE
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: LINE_TEMPLATE
                    content:
                      altText: Buttons template with custom actions
                      template:
                        thumbnailImageUrl: https://url.com/assets/image.png
                        imageAspectRatio: RECTANGLE
                        imageSize: COVER
                        imageBackgroundColor: '#FFFFFF'
                        title: Payload title
                        text: Payload test
                        defaultAction:
                          label: URI action
                          uri: https://url.com/assets/defaults/action
                          altUri: null
                          type: URI
                        actions:
                        - label: URI action
                          uri: https://url.com/assets/action
                          altUri: null
                          type: URI
                        - label: Picker action
                          data: Action data
                          mode: DATETIME
                          initial: null
                          max: 2024-01-01T00:00
                          min: 2024-01-01T00:00
                          type: DATETIMEPICKER
                        - label: Postback action
                          data: action=buy&itemid=123
                          displayText: null
                          text: null
                          type: POSTBACK
                        type: BUTTONS
                Successful response LINE message carousel TEMPLATE.:
                  summary: Successful response LINE message carousel TEMPLATE.
                  description: Successful response LINE message carousel TEMPLATE.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '1654088914'
                    to: Ud1c123456789abcd12345efd7aa01234
                    channel: LINE
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: LINE_TEMPLATE
                    content:
                      altText: Carousel template with custom actions
                      template:
                        columns:
                        - thumbnailImageUrl: https://url.com/assets/image1.png
                          imageBackgroundColor: '#FFFFFF'
                          title: Column 1 title
                          text: Column 1 text
                          defaultAction:
                            label: View detail 1
                            uri: https://url.com/assets/defaults/action1
                            altUri: null
                            type: URI
                          actions:
                          - label: View detail 1
                            uri: https://url.com/assets/action1
                            altUri: null
                            type: URI
                          - label: Buy item 1
                            data: action=buy&itemid=1
                            displayText: null
                            text: null
                            type: POSTBACK
                        - thumbnailImageUrl: https://url.com/assets/image2.png
                          imageBackgroundColor: '#BBBBBB'
                          title: Column 2 title
                          text: Column 2 text
                          defaultAction:
                            label: View detail 2
                            uri: https://url.com/assets/defaults/action2
                            altUri: null
                            type: URI
                          actions:
                          - label: View detail 2
                            uri: https://url.com/assets/action2
                            altUri: null
                            type: URI
                          - label: Buy item 2
                            data: action=buy&itemid=2
                            displayText: null
                            text: null
                            type: POSTBACK
                        imageAspectRatio: SQUARE
                        imageSize: CONTAIN
                        type: CAROUSEL
                Successful response LIVE CHAT TEXT message.:
                  summary: Successful response LIVE CHAT TEXT message.
                  description: Successful response LIVE CHAT TEXT message.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: LiveChatSender
                    to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                    channel: LIVE_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: TEXT
                    content:
                      text: Text content.
                Successful response LIVE CHAT LC_QUICK_REPLY message.:
                  summary: Successful response LIVE CHAT LC_QUICK_REPLY message.
                  description: Successful response LIVE CHAT LC_QUICK_REPLY message.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: LiveChatSender
                    to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                    channel: LIVE_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: LC_QUICK_REPLY
                    content:
                      suggestedReplies:
                      - 'Yes'
                      - 'No'
                      sourceType: TEXT
                      source:
                        text: Ready to ask?
                Successful response LIVE CHAT BUTTON message.:
                  summary: Successful response LIVE CHAT BUTTON message.
                  description: Successful response LIVE CHAT BUTTON message.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: LiveChatSender
                    to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                    channel: LIVE_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: BUTTON
                    content:
                      buttonType: LIVECHAT
                      button:
                        text: 'Try options below:'
                        buttonPayloads:
                        - title: 'Yes'
                          type: POSTBACK
                          payload: 'Yes'
                        - title: 'No'
                          type: POSTBACK
                          payload: 'No'
                        - title: Google
                          type: URL
                          payload: https://google.com
                Successful response LIVE CHAT VIDEO message.:
                  summary: Successful response LIVE CHAT VIDEO message.
                  description: Successful response LIVE CHAT VIDEO message.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: LiveChatSender
                    to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                    channel: LIVE_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: VIDEO
                    content:
                      caption: null
                      url: https://www.url.com/assets/video.avi
                Successful response LIVE CHAT IMAGE message.:
                  summary: Successful response LIVE CHAT IMAGE message.
                  description: Successful response LIVE CHAT IMAGE message.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: LiveChatSender
                    to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                    channel: LIVE_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: IMAGE
                    content:
                      caption: null
                      url: https://www.url.com/assets/image.jpg
                Successful response LIVE CHAT DOCUMENT message.:
                  summary: Successful response LIVE CHAT DOCUMENT message.
                  description: Successful response LIVE CHAT DOCUMENT message.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: LiveChatSender
                    to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                    channel: LIVE_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: DOCUMENT
                    content:
                      caption: null
                      url: https://www.url.com/assets/document.doc
                Successful response LIVE CHAT LC_CAROUSEL message.:
                  summary: Successful response LIVE CHAT LC_CAROUSEL message.
                  description: Successful response LIVE CHAT LC_CAROUSEL message.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: LiveChatSender
                    to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                    channel: LIVE_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: LC_CAROUSEL
                    content:
                      cards:
                      - title: Card title
                        description: Card description
                        imageUrl: https://image.url
                        cardActions:
                        - title: Open URL
                          postbackData: https://open.url
                          type: URL
                        - title: Send postback data
                          postbackData: data-to-send
                          type: POSTBACK_DATA
                      - title: Card title
                        description: Card description
                        imageUrl: https://image.url
                        cardActions:
                        - title: Open URL
                          postbackData: https://open.url
                          type: URL
                        - title: Send postback data
                          postbackData: data-to-send
                          type: POSTBACK_DATA
                      quickReplies: null
                Successful response LIVE CHAT LC_CAROUSEL message with quick replies.:
                  summary: Successful response LIVE CHAT LC_CAROUSEL message with quick replies.
                  description: Successful response LIVE CHAT LC_CAROUSEL message with quick replies.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: LiveChatSender
                    to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                    channel: LIVE_CHAT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: LC_QUICK_REPLY
                    content:
                      suggestedReplies:
                      - quick
                      - replies
                      reply: null
                      sourceType: CAROUSEL
                      source:
                        cards:
                        - title: Card title
                          description: Card description
                          imageUrl: https://image.url
                          cardActions:
                          - title: Open URL
                            postbackData: https://open.url
                            type: URL
                          - title: Send postback data
                            postbackData: data-to-send
                            type: POSTBACK_DATA
                        - title: Card title
                          description: Card description
                          imageUrl: https://image.url
                          cardActions:
                          - title: Open URL
                            postbackData: https://open.url
                            type: URL
                          - title: Send postback data
                            postbackData: data-to-send
                            type: POSTBACK_DATA
                        quickReplies: null
                Successful response SMS message.:
                  summary: Successful response SMS message.
                  description: Successful response SMS message.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: SMS
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: TEXT
                    content:
                      text: Text content.
                Successful response TELEGRAM message with IMAGE.:
                  summary: Successful response TELEGRAM message with IMAGE.
                  description: Successful response TELEGRAM message with IMAGE.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: TELEGRAM
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: IMAGE
                    content:
                      url: https://www.url.com/assets
                      caption: image.jpg
                Successful response TELEGRAM message with REPLY button.:
                  summary: Successful response TELEGRAM message with REPLY button.
                  description: Successful response TELEGRAM message with REPLY button.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '1234567890'
                    to: 0987654321
                    channel: TELEGRAM
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: TEXT
                    content:
                      replyMarkup:
                        keyboard:
                        - - text: Share contact information
                            type: TEXT_WITH_CONTACT
                        resizeKeyboard: true
                        oneTimeKeyboard: true
                        selective: false
                        type: REPLY_KEYBOARD_MARKUP_V2
                      text: Please share your contact data.
                      showUrlPreview: null
                Successful response VIBER message with LOCATION content.:
                  summary: Successful response VIBER message with LOCATION content.
                  description: Successful response VIBER message with LOCATION content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: DemoCompany
                    to: '44776333666'
                    channel: VIBER
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: LOCATION
                    content:
                      longitude: 1.2
                      latitude: 3.4
                      locationName: Location
                      address: Address Name
                Successful response VIBER BOT message with TEXT & KEYBOARD.:
                  summary: Successful response VIBER BOT message with TEXT & KEYBOARD.
                  description: Successful response VIBER BOT message with TEXT & KEYBOARD.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: pa:5555160884103864311
                    to: qTj/1PNa1/G8TUWwQBaRVA==
                    channel: VIBER_BOT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: TEXT
                    content:
                      keyboard:
                        buttonGrid:
                          buttons:
                          - columns: 6
                            rows: 1
                            action:
                              actionBody: Button postback 1
                              actionType: REPLY
                              silent: null
                              openUrlSettings: null
                              openMapLocation: null
                            text:
                              opacity: null
                              backgroundGradientColor: null
                              paddings: null
                              text: Button 1
                              verticalAlign: null
                              horizontalAlign: null
                              size: null
                              shouldFit: null
                            background:
                              color: '#00ffff'
                              frame: null
                              mediaUrl: null
                              mediaType: null
                              mediaScaleType: null
                              gifLoop: null
                            media: null
                          - columns: 6
                            rows: 2
                            action:
                              actionBody: Button postback 2
                              actionType: REPLY
                              silent: null
                              openUrlSettings: null
                              openMapLocation: null
                            text:
                              opacity: null
                              backgroundGradientColor: null
                              paddings: null
                              text: Button 2
                              verticalAlign: null
                              horizontalAlign: null
                              size: null
                              shouldFit: null
                            background:
                              color: '#00ff00'
                              frame: null
                              mediaUrl: null
                              mediaType: null
                              mediaScaleType: null
                              gifLoop: null
                            media: null
                          - columns: 6
                            rows: 1
                            action:
                              actionBody: Button postback 3
                              actionType: REPLY
                              silent: null
                              openUrlSettings: null
                              openMapLocation: null
                            text:
                              opacity: null
                              backgroundGradientColor: null
                              paddings: null
                              text: Button 3
                              verticalAlign: null
                              horizontalAlign: null
                              size: null
                              shouldFit: null
                            background:
                              color: '#ffff80'
                              frame: null
                              mediaUrl: null
                              mediaType: null
                              mediaScaleType: null
                              gifLoop: null
                            media: null
                          buttonsGroupColumns: 6
                          buttonsGroupRows: 4
                        backgroundColor: '#333333'
                        keyboardDisplay: null
                        actionBarState: HIDDEN
                      text: hello world
                      showUrlPreview: null
                Successful response VIBER BOT message with IMAGE.:
                  summary: Successful response VIBER BOT message with IMAGE.
                  description: Successful response VIBER BOT message with IMAGE.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: pa:5555160884103864311
                    to: qTj/1PNa1/G8TUWwQBaRVA==
                    channel: VIBER_BOT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: IMAGE
                    content:
                      caption: null
                      url: https://www.url.com/assets/image.jpg
                      previewUrl: null
                Successful response VIBER BOT message with VIDEO.:
                  summary: Successful response VIBER BOT message with VIDEO.
                  description: Successful response VIBER BOT message with VIDEO.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: pa:5555160884103864311
                    to: qTj/1PNa1/G8TUWwQBaRVA==
                    channel: VIBER_BOT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: VIBER_BOT_VIDEO
                    content:
                      caption: null
                      url: https://www.url.com/assets/video.avi
                      thumbnailUrl: null
                      fileName: null
                      size: 1500
                      duration: null
                Successful response VIBER BOT message with CONTACT.:
                  summary: Successful response VIBER BOT message with CONTACT.
                  description: Successful response VIBER BOT message with CONTACT.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: pa:5555160884103864311
                    to: qTj/1PNa1/G8TUWwQBaRVA==
                    channel: VIBER_BOT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: CONTACT
                    content:
                      contacts:
                      - addresses: null
                        birthday: null
                        emails:
                        - email: email@infobip.com
                          type: EMAIL
                        name:
                          firstName: Infobip
                          lastName: null
                          middleName: null
                          nameSuffix: null
                          namePrefix: null
                          formattedName: Infobip
                        org: null
                        phones:
                        - phone: '123456'
                          type: CELL
                          waId: '123456'
                        urls: null
                Successful response VIBER BOT message with LOCATION.:
                  summary: Successful response VIBER BOT message with LOCATION.
                  description: Successful response VIBER BOT message with LOCATION.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: pa:5555160884103864311
                    to: qTj/1PNa1/G8TUWwQBaRVA==
                    channel: VIBER_BOT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: LOCATION
                    content:
                      latitude: 44.9589555
                      longitude: 13.8513371
                      locationName: null
                      address: null
                Successful response VIBER BOT message with CAROUSEL.:
                  summary: Successful response VIBER BOT message with CAROUSEL.
                  description: Successful response VIBER BOT message with CAROUSEL.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: pa:5555160884103864311
                    to: qTj/1PNa1/G8TUWwQBaRVA==
                    channel: VIBER_BOT
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: VIBER_BOT_CAROUSEL
                    content:
                      fromDetails:
                        name: Example Name
                        avatarUrl: null
                      heightScale: 100
                      backgroundColor: null
                      buttonGrid:
                        buttons:
                        - columns: 3
                          rows: 2
                          action:
                            actionBody: image 1 clicked
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text: null
                          background: null
                          media:
                            imageUrl: https://url.com/assets/image1.png
                            imageScaleType: FIT
                        - columns: 3
                          rows: 1
                          action:
                            actionBody: Example 1 clicked
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text:
                            opacity: null
                            backgroundGradientColor: null
                            paddings: null
                            text: Example 1
                            verticalAlign: MIDDLE
                            horizontalAlign: CENTER
                            size: LARGE
                            shouldFit: null
                          background: null
                          media: null
                        - columns: 3
                          rows: 1
                          action:
                            actionBody: Buy Example 1
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text:
                            opacity: null
                            backgroundGradientColor: null
                            paddings: null
                            text: Buy this one
                            verticalAlign: null
                            horizontalAlign: null
                            size: null
                            shouldFit: null
                          background:
                            color: '#ff0000'
                            frame:
                              borderWidth: null
                              borderColor: null
                              cornerRadius: 4
                            mediaUrl: null
                            mediaType: null
                            mediaScaleType: null
                            gifLoop: null
                          media: null
                        - columns: 3
                          rows: 2
                          action:
                            actionBody: image 2 clicked
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text: null
                          background: null
                          media:
                            imageUrl: https://url.com/assets/image2.png
                            imageScaleType: CROP
                        - columns: 3
                          rows: 1
                          action:
                            actionBody: Example 2 clicked
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text:
                            opacity: null
                            backgroundGradientColor: null
                            paddings: null
                            text: Example 2
                            verticalAlign: MIDDLE
                            horizontalAlign: CENTER
                            size: LARGE
                            shouldFit: null
                          background: null
                          media: null
                        - columns: 3
                          rows: 1
                          action:
                            actionBody: Buy Example 2
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text:
                            opacity: null
                            backgroundGradientColor: null
                            paddings: null
                            text: Buy this one
                            verticalAlign: null
                            horizontalAlign: null
                            size: null
                            shouldFit: null
                          background:
                            color: '#ff0000'
                            frame:
                              borderWidth: null
                              borderColor: null
                              cornerRadius: 4
                            mediaUrl: null
                            mediaType: null
                            mediaScaleType: null
                            gifLoop: null
                          media: null
                        - columns: 3
                          rows: 2
                          action:
                            actionBody: image 3 clicked
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text: null
                          background: null
                          media:
                            imageUrl: https://url.com/assets/image3.png
                            imageScaleType: FIT
                        - columns: 3
                          rows: 1
                          action:
                            actionBody: Example 3 clicked
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text:
                            opacity: null
                            backgroundGradientColor: null
                            paddings: null
                            text: Example 3
                            verticalAlign: MIDDLE
                            horizontalAlign: CENTER
                            size: LARGE
                            shouldFit: null
                          background: null
                          media: null
                        - columns: 3
                          rows: 1
                          action:
                            actionBody: Buy Example 3
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text:
                            opacity: null
                            backgroundGradientColor: null
                            paddings: null
                            text: Buy this one
                            verticalAlign: null
                            horizontalAlign: null
                            size: null
                            shouldFit: null
                          background:
                            color: '#ff0000'
                            frame:
                              borderWidth: null
                              borderColor: null
                              cornerRadius: 4
                            mediaUrl: null
                            mediaType: null
                            mediaScaleType: null
                            gifLoop: null
                          media: null
                        - columns: 3
                          rows: 2
                          action:
                            actionBody: image 4 clicked
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text: null
                          background: null
                          media:
                            imageUrl: https://url.com/assets/image4.png
                            imageScaleType: null
                        - columns: 3
                          rows: 1
                          action:
                            actionBody: Example 4 clicked
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text:
                            opacity: null
                            backgroundGradientColor: null
                            paddings: null
                            text: Example 4
                            verticalAlign: MIDDLE
                            horizontalAlign: CENTER
                            size: LARGE
                            shouldFit: null
                          background: null
                          media: null
                        - columns: 3
                          rows: 1
                          action:
                            actionBody: Buy Example 4
                            actionType: REPLY
                            silent: null
                            openUrlSettings: null
                            openMapLocation: null
                          text:
                            opacity: null
                            backgroundGradientColor: null
                            paddings: null
                            text: Buy this one
                            verticalAlign: null
                            horizontalAlign: null
                            size: null
                            shouldFit: null
                          background: null
                          media: null
                        buttonsGroupColumns: 3
                        buttonsGroupRows: 4
                Successful response WHATSAPP message with IMAGE content.:
                  summary: Successful response WHATSAPP message with IMAGE content.
                  description: Successful response WHATSAPP message with IMAGE content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: IMAGE
                    content:
                      caption: null
                      url: https://www.url.com/assets/image.jpg
                Successful response WHATSAPP message with DOCUMENT content.:
                  summary: Successful response WHATSAPP message with DOCUMENT content.
                  description: Successful response WHATSAPP message with DOCUMENT content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: DOCUMENT
                    content:
                      caption: null
                      url: https://www.url.com/assets/document.doc
                Successful response WHATSAPP message with VIDEO content.:
                  summary: Successful response WHATSAPP message with VIDEO content.
                  description: Successful response WHATSAPP message with VIDEO content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: VIDEO
                    content:
                      caption: null
                      url: https://www.url.com/assets/video.avi
                Successful response WHATSAPP message with AUDIO content.:
                  summary: Successful response WHATSAPP message with AUDIO content.
                  description: Successful response WHATSAPP message with AUDIO content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: AUDIO
                    content:
                      url: https://www.url.com/assets/audio.jpg
                Successful response WHATSAPP message with CONTACT content.:
                  summary: Successful response WHATSAPP message with CONTACT content.
                  description: Successful response WHATSAPP message with CONTACT content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: CONTACT
                    content:
                      contacts:
                      - name:
                          first_name: First Name
                          last_name: Last Name
                          formatted_name: Formatted First Last Name
                        org:
                          company: Company Name
                        emails:
                        - email: first@last@company.com
                          type: private
                        urls:
                        - url: https://url.com/assets/profile
                          type: PROFILE
                        birthday: '2019-02-18'
                        addresses:
                        - city: City
                          country: Country
                          countryCode: '123'
                          street: Street name
                          type: WORK
                          zip: '12345'
                        phones:
                        - phone: +123 456 789
                          type: Mobile
                          waId: '123456'
                        - phone: +123 456 7890
                          type: Work
                Successful response WHATSAPP message with TEMPLATE content.:
                  summary: Successful response WHATSAPP message with TEMPLATE content.
                  description: Successful response WHATSAPP message with TEMPLATE content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: TEXT
                    content:
                      text: Template text
                Successful response WHATSAPP message with TEXT MEDIA TEMPLATE content.:
                  summary: Successful response WHATSAPP message with TEXT MEDIA TEMPLATE content.
                  description: Successful response WHATSAPP message with TEXT MEDIA TEMPLATE content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: MEDIA_TEMPLATE
                    content:
                      templateName: text_media_template
                      language:
                        code: en
                        label: English
                      header:
                        placeholder: Gustavo
                        type: TEXT
                      body:
                        placeholders:
                        - 6-15
                        - 17-19
                      buttons:
                      - parameters:
                        - Contact support
                        type: URL
                Successful response WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.:
                  summary: Successful response WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.
                  description: Successful response WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: MEDIA_TEMPLATE
                    content:
                      templateName: document_media_template
                      language:
                        code: en
                        label: English
                      header:
                        type: DOCUMENT
                        url: https://www.url.com/assets
                        filename: document.pdf
                      body:
                        placeholders:
                        - 6-15
                        - 17-19
                      buttons:
                      - parameters:
                        - 'Yes'
                        type: QUICK_REPLY
                      - parameters:
                        - 'No'
                        type: QUICK_REPLY
                Successful response WHATSAPP message with IMAGE MEDIA TEMPLATE content.:
                  summary: Successful response WHATSAPP message with IMAGE MEDIA TEMPLATE content.
                  description: Successful response WHATSAPP message with IMAGE MEDIA TEMPLATE content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: MEDIA_TEMPLATE
                    content:
                      templateName: image_media_template
                      language:
                        code: en
                        label: English
                      header:
                        type: IMAGE
                        url: https://www.url.com/assets/image.jpg
                      body:
                        placeholders:
                        - 6-15
                        - 17-19
                      buttons:
                      - parameters:
                        - 'Yes'
                        type: QUICK_REPLY
                      - parameters:
                        - 'No'
                        type: QUICK_REPLY
                Successful response WHATSAPP message with LOCATION MEDIA TEMPLATE content.:
                  summary: Successful response WHATSAPP message with LOCATION MEDIA TEMPLATE content.
                  description: Successful response WHATSAPP message with LOCATION MEDIA TEMPLATE content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: MEDIA_TEMPLATE
                    content:
                      templateName: location_media_template
                      language:
                        code: en
                        label: English
                      header:
                        latitude: 45.79359
                        longitude: 15.94613
                        type: LOCATION
                      body:
                        placeholders:
                        - 6-15
                        - 17-19
                      buttons:
                      - parameters:
                        - Contact support
                        type: URL
                Successful response WHATSAPP message with VIDEO MEDIA TEMPLATE content.:
                  summary: Successful response WHATSAPP message with VIDEO MEDIA TEMPLATE content.
                  description: Successful response WHATSAPP message with VIDEO MEDIA TEMPLATE content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: MEDIA_TEMPLATE
                    content:
                      templateName: video_media_template
                      language:
                        code: en
                        label: English
                      header:
                        type: VIDEO
                        url: https://www.url.com/assets/video.avi
                      body:
                        placeholders:
                        - 6-15
                        - 17-19
                      buttons:
                      - parameters:
                        - 'Yes'
                        type: QUICK_REPLY
                      - parameters:
                        - 'No'
                        type: QUICK_REPLY
                Successful response WHATSAPP message with INTERACTIVE BUTTON content.:
                  summary: Successful response WHATSAPP message with INTERACTIVE BUTTON content.
                  description: Successful response WHATSAPP message with INTERACTIVE BUTTON content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447123456789'
                    to: '44987654321'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: INTERACTIVE
                    content:
                      interactive:
                        header:
                          text: send reply header text
                          type: IMAGE
                          url: https://www.url.com/assets/image.jpg
                        body:
                          text: send reply body text
                        footer:
                          text: send reply footer text
                        action:
                          buttons:
                          - id: postback 1
                            title: button 1
                            type: BUTTON
                          - id: postback 2
                            title: button 2
                            type: BUTTON
                          button: null
                          sections: null
                        type: BUTTON
                Successful response WHATSAPP message with INTERACTIVE URL BUTTON content.:
                  summary: Successful response WHATSAPP message with INTERACTIVE URL BUTTON content.
                  description: Successful response WHATSAPP message with INTERACTIVE URL BUTTON content.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    from: '447123456789'
                    to: '44987654321'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: INTERACTIVE
                    content:
                      interactive:
                        header:
                          text: send reply header text
                          type: TEXT
                        body:
                          text: send reply body text
                        footer:
                          text: send reply footer text
                        action:
                          displayText: display text
                          url: http://localhost:8000
                        type: URL_BUTTON
                Successful response WHATSAPP message with INTERACTIVE LIST content.:
                  summary: Successful response WHATSAPP message with INTERACTIVE LIST content.
                  description: Successful response WHATSAPP message with INTERACTIVE LIST content.
                  value:
                    id: e80552ae-d8e6-4123-93a3-35e7721d1cdd
                    from: '447123456789'
                    to: '44987654321'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: INTERACTIVE
                    content:
                      interactive:
                        header:
                          text: header text
                          type: TEXT
                          url: null
                        body:
                          text: body text
                        footer:
                          text: footer text
                        action:
                          buttons: null
                          button: options
                          sections:
                          - title: section1 title
                            rows:
                            - id: row1.1
                              title: title1.1
                              description: description1.1
                            - id: row1.2
                              title: title1.2
                              description: description1.2
                          - title: section2 title
                            rows:
                            - id: row2.1
                              title: title2.1
                              description: description2.1
                        type: LIST
                Successful response WHATSAPP message with INTERACTIVE PRODUCT content.:
                  summary: Successful response WHATSAPP message with INTERACTIVE PRODUCT content.
                  description: Successful response WHATSAPP message with INTERACTIVE PRODUCT content.
                  value:
                    id: e80552ae-d8e6-4123-93a3-35e7721d1cdd
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: WHATSAPP_PRODUCT
                    content:
                      body:
                        text: Test Product 1
                      footer:
                        text: Test footer 1
                      action:
                        catalogId: '123456789'
                        productRetailerId: productRetailerId
                Successful response WHATSAPP message with INTERACTIVE MULTI PRODUCT content.:
                  summary: Successful response WHATSAPP message with INTERACTIVE MULTI PRODUCT content.
                  description: Successful response WHATSAPP message with INTERACTIVE MULTI PRODUCT content.
                  value:
                    id: e80552ae-d8e6-4123-93a3-35e7721d1cdd
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: WHATSAPP_MULTI_PRODUCT
                    content:
                      header:
                        text: Header multi 1
                      body:
                        text: Test Multi Product 1
                      footer:
                        text: Test multi footer 1
                      action:
                        catalogId: '123456789'
                        sections:
                        - title: section 1
                          productItems:
                          - productRetailerId: retailerId
                          - productRetailerId: productRetailerId
                Successful response WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.:
                  summary: Successful response WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.
                  description: Successful response WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.
                  value:
                    id: e80552ae-d8e6-4123-93a3-35e7721d1cdd
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: INTERACTIVE
                    content:
                      interactive:
                        type: CALL_PERMISSION_REQUEST
                Successful response WHATSAPP message with INTERACTIVE VOICE_BUTTON content.:
                  summary: Successful response WHATSAPP message with INTERACTIVE VOICE_BUTTON content.
                  description: Successful response WHATSAPP message with INTERACTIVE VOICE_BUTTON content.
                  value:
                    id: e80552ae-d8e6-4123-93a3-35e7721d1cdd
                    from: '447492263897'
                    to: '44776333666'
                    channel: WHATSAPP
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: INTERACTIVE
                    content:
                      interactive:
                        body:
                          text: body text
                        action:
                          buttonDisplayText: button display text
                        type: VOICE_BUTTON
                Successful response WHATSAPP message with INTERACTIVE FLOW content.:
                  summary: Successful response WHATSAPP message with INTERACTIVE FLOW content.
                  description: Successful response WHATSAPP message with INTERACTIVE FLOW content.
                  value:
                    id: 22cb064a-ca48-45c7-9384-ccf233fd81ee
                    channel: WHATSAPP
                    from: '447701408772'
                    to: '420951141432'
                    direction: OUTBOUND
                    conversationId: 1227ce3b-93f8-4784-8e9b-099513c465f1
                    authorId: 409b6133-92be-4a8d-99ae-f4578f118f87
                    authorType: AGENT
                    createdAt: '2025-09-10T13:03:39.173+00:00'
                    updatedAt: '2025-09-10T13:03:39.173+00:00'
                    content:
                      interactive:
                        header:
                          text: header text
                          type: TEXT
                          url: null
                        body:
                          text: body text
                        footer:
                          text: footer text
                        action:
                          buttons: null
                          button: null
                          sections: null
                          flowActionContent:
                            mode: PUBLISHED
                            messageVersion: 1
                            flowToken: Flow_token
                            flowId: 98E8D4AA79E2693357FAA
                            callToActionButton: start
                            flowAction: DATA_EXCHANGE
                            flowActionPayload:
                              screenId: av4b064a-ca48-45c7-9384-ccf233fd81ee
                              data:
                                data: test
                          displayText: null
                          url: null
                          buttonDisplayText: null
                        type: FLOW
                    contentType: INTERACTIVE
                Successful response WHATSAPP message with INTERACTIVE REQUEST_CONTACT_INFO_BUTTON content.:
                  summary: Successful response WHATSAPP message with INTERACTIVE REQUEST_CONTACT_INFO_BUTTON content.
                  description: Successful response WHATSAPP message with INTERACTIVE REQUEST_CONTACT_INFO_BUTTON content.
                  value: "{\n    \"id\": \"22cb064a-ca48-45c7-9384-ccf233fd81ee\",\n    \"channel\": \"WHATSAPP\",\n    \"from\": \"447701408772\",\n    \"to\": \"420951141432\",\n    \"direction\": \"OUTBOUND\",\n    \"conversationId\": \"1227ce3b-93f8-4784-8e9b-099513c465f1\",\n    \"authorId\": \"409b6133-92be-4a8d-99ae-f4578f118f87\",\n    \"authorType\": \"AGENT\",\n    \"createdAt\": \"2025-09-10T13:03:39.173+00:00\",\n    \"updatedAt\": \"2025-09-10T13:03:39.173+00:00\",\n    \"contentType\": \"INTERACTIVE\"\n    \"content\": {\n        \"interactive\": {\n          \"header\": null,\n          \"body\": {\n            \"text\": \"Requesting contact info\"\n          },\n          \"footer\": null,\n          \"action\": null,\n          \"type\": \"REQUEST_CONTACT_INFO\"\n        }\n      }\n}\n"
                Successful response EMAIL message with EMAIL html content.:
                  summary: Successful response EMAIL message with EMAIL html content.
                  description: Successful response EMAIL message with EMAIL html content.
                  value:
                    id: e80552ae-d8e6-4123-93a3-35e7721d1cdd
                    from: sender@example.com
                    to: toRecipient1@example.com
                    channel: EMAIL
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: EMAIL
                    content:
                      toAddresses:
                      - toRecipient1@example.com
                      - toRecipient2@example.com
                      ccAddresses:
                      - ccRecipient@example.com
                      bccAddresses:
                      - bccRecipient@example.com
                      subject: Sample Email Subject
                      contentHtml: <html><body>This is a sample email content.</body></html>
                Successful response EMAIL message with EMAIL text content.:
                  summary: Successful response EMAIL message with EMAIL text content.
                  description: Successful response EMAIL message with EMAIL text content.
                  value:
                    id: e80552ae-d8e6-4123-93a3-35e7721d1cdd
                    from: sender@example.com
                    to: toRecipient1@example.com
                    channel: EMAIL
                    direction: OUTBOUND
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    contentType: EMAIL
                    content:
                      toAddresses:
                      - toRecipient1@example.com
                      - toRecipient2@example.com
                      ccAddresses:
                      - ccRecipient@example.com
                      bccAddresses:
                      - bccRecipient@example.com
                      subject: Sample Email Subject
                      contentText: This is a sample of the email content.
                Successful response RCS message with TEXT content.:
                  summary: Successful response RCS message with TEXT content.
                  description: Successful response RCS message with TEXT content.
                  value:
                    id: c8258ab8-d65b-4546-afbb-78a521b6acae
                    channel: RCS
                    from: infobip
                    to: '385989295741'
                    direction: OUTBOUND
                    conversationId: 2ca99fb3-0f2e-47b0-b463-8dbc408b92ec
                    authorId: 409b6133-92be-4a8d-99ae-f4578f118f78
                    authorType: AGENT
                    createdAt: '2025-09-08T07:29:47.116+00:00'
                    updatedAt: '2025-09-08T07:29:47.116+00:00'
                    content:
                      text: Test reply
                      showUrlPreview: null
                    contentType: TEXT
                Successful response RCS message with FILE content.:
                  summary: Successful response RCS message with FILE content.
                  description: Successful response RCS message with FILE content.
                  value:
                    id: aa62c649-bf35-4ec6-ae93-836a1ca3f5cc
                    channel: RCS
                    from: infobip
                    to: '385989295741'
                    direction: OUTBOUND
                    conversationId: 2ca88fb3-0f2e-47b0-b463-8dbc408b29ec
                    authorId: 409b6133-92be-4a8d-88ae-f4578f118f87
                    authorType: AGENT
                    createdAt: '2025-09-08T07:08:24.708+00:00'
                    updatedAt: '2025-09-08T07:08:24.708+00:00'
                    content:
                      file:
                        url: https://url.com/assets/document.pdf
                      thumbnail:
                        url: https://url.com/assets/thumbnail.pdf
                      suggestions: null
                    contentType: RCS_FILE
                Successful response RCS message with CARD content.:
                  summary: Successful response RCS message with CARD content.
                  description: Successful response RCS message with CARD content.
                  value:
                    id: f4858822-e603-4244-8127-b91700b771ec
                    channel: RCS
                    from: infobip
                    to: '385989295741'
                    direction: OUTBOUND
                    conversationId: 2ca99fb3-0f2e-47b0-b463-8dbc518b29ec
                    authorId: 409b6133-92be-4a8d-99ae-f3378f118f87
                    authorType: AGENT
                    createdAt: '2025-09-08T07:21:18.670+00:00'
                    updatedAt: '2025-09-08T07:21:18.670+00:00'
                    content:
                      orientation: HORIZONTAL
                      alignment: RIGHT
                      content:
                        title: rcs card title
                        description: rcs card description
                        media:
                          file:
                            url: https://url.com/assets/image1.png
                          thumbnail:
                            url: https://url.com/assets/image2.png
                          height: MEDIUM
                        suggestions: null
                      suggestions: null
                    contentType: RCS_CARD
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
                Missing 'to' field:
                  summary: Missing 'to' field
                  description: Missing 'to' field
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          to:
                          - must not be blank
                Missing 'from' field:
                  summary: Missing 'from' field
                  description: Missing 'from' field
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          from:
                          - must not be blank
                Content must not be blank:
                  summary: Content must not be blank
                  description: Content must not be blank
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content:
                          - must not be blank
                Content length exceeds limit:
                  summary: Content length exceeds limit
                  description: Content length exceeds limit
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content:
                          - size cannot be longer than 4096 characters.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}/events:
    post:
      tags:
      - customer-engagement
      summary: Send a conversation event
      description: Use this endpoint to send an event to a conversation. E.g. indication when typing started or ended.<a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: send-event
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation to set event for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventApiRequest'
            examples:
              Sending APPLE BUSINESS CHAT Typing Started event.:
                summary: Sending APPLE BUSINESS CHAT Typing Started event.
                description: Sending APPLE BUSINESS CHAT Typing Started event.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  type: TYPING_STARTED
              Sending APPLE BUSINESS CHAT Typing Stopped event.:
                summary: Sending APPLE BUSINESS CHAT Typing Stopped event.
                description: Sending APPLE BUSINESS CHAT Typing Stopped event.
                value:
                  from: 03dff63b-6100-44a9-b563-8fbc0295ec77
                  to: urn:urnId
                  channel: APPLE_BUSINESS_CHAT
                  type: TYPING_STOPPED
              Sending LIVE CHAT Typing Started event.:
                summary: Sending LIVE CHAT Typing Started event.
                description: Sending LIVE CHAT Typing Started event.
                value:
                  from: 25774a87-078a-4fe7-8d43-127809479964
                  to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                  channel: LIVE_CHAT
                  type: TYPING_STARTED
              Sending LIVE CHAT Typing Stopped event.:
                summary: Sending LIVE CHAT Typing Stopped event.
                description: Sending LIVE CHAT Typing Stopped event.
                value:
                  from: 25774a87-078a-4fe7-8d43-127809479964
                  to: CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002
                  channel: LIVE_CHAT
                  type: TYPING_STOPPED
              Sending WHATSAPP Typing Started event.:
                summary: Sending WHATSAPP Typing Started event.
                description: Sending WHATSAPP Typing Started event.
                value:
                  from: '44123456789'
                  to: '44321654987'
                  channel: WHATSAPP
                  type: TYPING_STARTED
        required: true
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Channel is not supported for provided event type:
                  summary: Channel is not supported for provided event type
                  description: Channel is not supported for provided event type
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Channel is not supported for provided event type
                Typing events are not supported during Apple Satellite sessions:
                  summary: Typing events are not supported during Apple Satellite sessions
                  description: Typing events are not supported during Apple Satellite sessions
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Typing events are not supported during Apple Satellite sessions
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}/notes:
    get:
      tags:
      - customer-engagement
      summary: Get notes
      description: Use this method to get a list of notes from conversation with pagination. <a href="https://www.infobip.com/docs/conversations-api/notes" target="_blank">More info</a>
      operationId: get-notes
      parameters:
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: 'This parameter is used to order your results.

          If an order is not given, the default order id:asc will be applied.

          Possible ordering fields are properties.

          Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: conversationId
        in: path
        description: Id of the conversation to get notes from.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    post:
      tags:
      - customer-engagement
      summary: Create note
      description: Use this method to create a new note. Use notes to notify your team on important matters regarding a conversation with a customer. <a href="https://www.infobip.com/docs/conversations-api/notes" target="_blank">More info</a>
      operationId: create-note
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation to set note to.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateNoteApiRequest'
            examples:
              Text note.:
                summary: Text note.
                description: Text note.
                value:
                  content: Note content
                  agentId: c856e230-a8cd-498b-9996-42bbed35029a
              Note with attachments.:
                summary: Note with attachments.
                description: Note with attachments.
                value:
                  type: ATTACHMENT
                  content:
                    text: Note content
                    attachments:
                    - id: '12345'
                    - id: '67890'
                  agentId: c856e230-a8cd-498b-9996-42bbed35029a
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteApiResponse'
              examples:
                Successful response for a text note:
                  summary: Successful response for a text note
                  description: Successful response for a text note
                  value:
                    id: 1367466e-7e5d-40d7-a78a-ace2780ed3dd
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    agentId: c856e230-a8cd-498b-9996-42bbed35029a
                    type: INTERNAL
                    content: Note content
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                Successful response for a note with attachments:
                  summary: Successful response for a note with attachments
                  description: Successful response for a note with attachments
                  value:
                    id: 1367466e-7e5d-40d7-a78a-ace2780ed3dd
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    agentId: 8066d92f-94b6-4596-b7e0-b6595ca76d2e
                    type: ATTACHMENT
                    content:
                      text: Note content
                      attachments:
                      - id: '12345'
                        fileName: File 1 Name
                        fileExtension: png
                        contentType: image/png
                        fileSize: 12
                        publicLink: https://www.url.com/assets/image1.png
                      - id: '56789'
                        fileName: File 2 Name
                        fileExtension: png
                        contentType: image/png
                        fileSize: 34
                        publicLink: https://www.url.com/assets/image1.png
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}/notes/{noteId}:
    get:
      tags:
      - customer-engagement
      summary: Get note
      description: Use this method to retrieve a note. <a href="https://www.infobip.com/docs/conversations-api/notes" target="_blank">More info</a>
      operationId: get-note
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation to get a note from.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: noteId
        in: path
        description: Note Id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 1367466e-7e5d-40d7-a78a-ace2780ed3dd
                    conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
                    agentId: c856e230-a8cd-498b-9996-42bbed35029a
                    type: INTERNAL
                    content: Note content
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
  /ccaas/1/agents:
    get:
      tags:
      - customer-engagement
      summary: Get agents
      description: Use this method to get a list of agents with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in parameters. <a href="https://www.infobip.com/docs/conversations/get-started" target="_blank">More info</a>
      operationId: get-agents
      parameters:
      - name: agentIds
        in: query
        description: Optional filter. List of agents Id to match result.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: queueIds
        in: query
        description: Optional filter. List of queues Id to match result.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: displayName
        in: query
        description: Optional. Agent display name. This is case insensitive and will search for substring anywhere within string, 255 characters max.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: email
        in: query
        description: Optional. Agent email.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: email
      - name: status
        in: query
        description: Optional. Indicates a status set by the agent reflecting their availability preferences.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - ACTIVE
          - BUSY
          - INVISIBLE
          - AWAY
      - name: availability
        in: query
        description: Optional. Indicates the agent status set by the system reflecting the actual availability.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - ACTIVE
          - BUSY
          - INVISIBLE
          - AWAY
      - name: role
        in: query
        description: Optional. Agent role.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - AGENT
          - SUPERVISOR
      - name: enabled
        in: query
        description: Optional. Agent enable/disable toggle.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: createdAfter
        in: query
        description: 'Optional. Filter results created after specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdBefore
        in: query
        description: 'Optional. Filter results created before specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedAfter
        in: query
        description: 'Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedBefore
        in: query
        description: 'Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: 'This parameter is used to order your results.

          If an order is not given, the default order id:asc will be applied.

          Possible ordering fields are properties.

          Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponseResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    post:
      tags:
      - customer-engagement
      summary: Create agent
      description: Use this method to add a new agent. <a href="https://www.infobip.com/docs/conversations/get-started" target="_blank">More info</a>
      operationId: create-agent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 97457D13B1FC79AF3C1A1096AE7E77AB
                    displayName: Angus Young
                    status: INVISIBLE
                    role: AGENT
                    enabled: true
                    createdAt: 2019-05-10T09:53:58.463+0000
                    updatedAt: 2019-05-10T09:53:58.463+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/agents/{agentId}:
    get:
      tags:
      - customer-engagement
      summary: Get agent
      description: Use this method to get a single agent. <a href="https://www.infobip.com/docs/conversations/get-started" target="_blank">More info</a>
      operationId: get-agent
      parameters:
      - name: agentId
        in: path
        description: Id of the agent we want to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponseWithEmail'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 97457D13B1FC79AF3C1A1096AE7E77AB
                    displayName: Angus Young
                    status: INVISIBLE
                    role: AGENT
                    enabled: true
                    createdAt: 2019-05-10T09:53:58.463+0000
                    updatedAt: 2019-05-10T09:53:58.463+0000
                    email: angus.toung@example.com
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Update agent
      description: Use this method to update an agent. <a href="https://www.infobip.com/docs/conversations/get-started" target="_blank">More info</a>
      operationId: update-agent
      parameters:
      - name: agentId
        in: path
        description: Id of the Agent we want to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 97457D13B1FC79AF3C1A1096AE7E77AB
                    displayName: Angus Young
                    status: INVISIBLE
                    role: AGENT
                    enabled: true
                    createdAt: 2019-05-10T09:53:58.463+0000
                    updatedAt: 2019-08-21T11:33:52.222+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/agents/{agentId}/conversations:
    get:
      tags:
      - customer-engagement
      summary: Get agent conversations
      description: Use this method to get a list of conversations, an agent is assigned on, with pagination.
      operationId: get-agent-conversations
      parameters:
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: 'This parameter is used to order your results.

          If an order is not given, the default order id:asc will be applied.

          Possible ordering fields are properties.

          Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: agentId
        in: path
        description: Agent id to get conversations.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
  /ccaas/1/agents/{agentId}/status:
    put:
      tags:
      - customer-engagement
      summary: Change agents status
      description: Use this method to change agents status. <a href="https://www.infobip.com/docs/conversations/get-started" target="_blank">More info</a>
      operationId: update-agent-status
      parameters:
      - name: agentId
        in: path
        description: Id of the Agent we want to change status.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 97457D13B1FC79AF3C1A1096AE7E77AB
                    displayName: Angus Young
                    status: ACTIVE
                    role: SUPERVISOR
                    enabled: true
                    createdAt: 2019-05-10T09:53:58.463+0000
                    updatedAt: 2019-08-21T11:33:52.222+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/agents/{agentId}/queues:
    post:
      tags:
      - customer-engagement
      summary: Add agent to queue
      description: Use this method to add an agent to a queue.
      operationId: add-agent-queue
      parameters:
      - name: agentId
        in: path
        description: Id of the Agent which should be assign to Queue.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.QueueAssignRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Success request response:
                  summary: Success request response
                  description: Success request response
                  value:
                    statusCode: SUCCESS
                    message: Agent added to queue successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/agents/{agentId}/queues/{queueId}:
    delete:
      tags:
      - customer-engagement
      summary: Remove agent from queue
      description: 'Use this method to remove an agent from a queue.

        Operation only deletes the link between a queue and the agent.'
      operationId: remove-agent-queue
      parameters:
      - name: agentId
        in: path
        description: Id of the Agent which should be unlinked from queue.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: queueId
        in: path
        description: Id of the Queue which should be unlinked from agent.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Success request response:
                  summary: Success request response
                  description: Success request response
                  value:
                    statusCode: SUCCESS
                    message: Agent removed from queue successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/agents/{agentId}/heartbeat:
    put:
      tags:
      - customer-engagement
      summary: Set agents heartbeat
      description: Use this method to set agents heartbeat. <a href="https://www.infobip.com/docs/conversations/get-started" target="_blank">More info</a>
      operationId: update-agent-heartbeat
      parameters:
      - name: agentId
        in: path
        description: Id of the Agent we want to set heartbeat.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Heartbeat received.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/queues:
    get:
      tags:
      - customer-engagement
      summary: Get queues
      description: 'Use this method to get a list of queues with pagination and filtering options. Using a filter is optional.

        The result can be filtered by one or many optional filters described in the parameters.

        <a href="https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing" target="_blank">More info</a>'
      operationId: get-queues
      parameters:
      - name: queueIds
        in: query
        description: Optional filter. List of queue Ids.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: agentId
        in: query
        description: Optional filter. Agent Id.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: workingHoursId
        in: query
        description: Optional filter. Working Hours Id.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: 'This parameter is used to order your results.

          If an order is not given, the default order id:asc will be applied.

          Possible ordering fields are properties.

          Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: Optional. Queue name.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    post:
      tags:
      - customer-engagement
      summary: Create queue
      description: 'Use this method to create a queue.

        Queues help manage conversations in a timely manner by organizing the team based on workload and knowledge.

        <a href="https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing" target="_blank">More info</a>'
      operationId: create-queue
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateQueueApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    name: Queue name
                    enabledAgentsCount: null
                    enabledRoutesCount: null
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    isAutoAssignmentEnabled: false
                    stickyAgentTimeoutDays: 30
                    isStickyAutoAssignmentEnabled: null
                    workingHoursId: null
                    isPrivate: false
                    deletedAt: null
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/queues/{queueId}:
    put:
      tags:
      - customer-engagement
      summary: Update queue
      description: Use this method to update the queue. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing" target="_blank">More info</a>
      operationId: update-queue
      parameters:
      - name: queueId
        in: path
        description: Id of the queue being updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.UpdateQueueApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    name: Queue name
                    enabledAgentsCount: null
                    enabledRoutesCount: null
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    isAutoAssignmentEnabled: false
                    stickyAgentTimeoutDays: 30
                    isStickyAutoAssignmentEnabled: null
                    workingHoursId: null
                    isPrivate: false
                    deletedAt: null
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    delete:
      tags:
      - customer-engagement
      summary: Delete queue
      description: Use this method to delete a queue. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing" target="_blank">More info</a>
      operationId: delete-queue
      parameters:
      - name: queueId
        in: path
        description: Id of the queue to be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Success request response:
                  summary: Success request response
                  description: Success request response
                  value:
                    statusCode: SUCCESS
                    message: Queue deleted successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/routing:
    get:
      tags:
      - customer-engagement
      summary: Get routing
      description: Use this method to get a list of rules within the routing. Pagination is set to single page result with a maximum of 999 items ordered by "order". As rules inside routing are stored, executed and retrieved in provided order with the SET method, that order can't be changed. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing" target="_blank">More info</a>
      operationId: get-routing
      parameters:
      - name: ruleIds
        in: query
        description: Optional. List of rule Ids.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: enabled
        in: query
        description: Optional. Rule enable/disable toggle.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RoutingRulesResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Create routing
      description: 'Create routing method creates a new routing setup if it does not exist or replaces the existing setup. As rules inside routing are stored, executed, and retrieved in the provided order with this method, that order cannot be changed. Every expression within routing can be constructed with at least one or more available operators. The result of the expression will be a success (TRUE) only if all results of operations are TRUE. The query will be executed, one expression after another, in the order they are submitted until new a inbound message first matches the expression. Then the message will be assigned to the matched queue.


        The order of rules inside routing is essential for proper routing, as rules match in the provided order. The first rule matching the message will be used.

        <a href="https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing" target="_blank">More info</a>'
      operationId: update-routing
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateRuleApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Success:
                  summary: Success
                  description: Success
                  value:
                    statusCode: SUCCESS
                    message: Routing added successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    delete:
      tags:
      - customer-engagement
      summary: Delete routing
      description: 'Use this method to delete routing. No parameters are required for this action.


        This operation will delete routing with all rules inside, so all new inbound messages destined to routing will be routed to the default queue.

        <a href="https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing" target="_blank">More info</a>'
      operationId: delete-routing
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Routing deleted successfully.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/bots:
    get:
      tags:
      - customer-engagement
      summary: Get Bots
      description: Use this method to get bots with pagination. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#connect-external-bots-self-service-automation" target="_blank">More info</a>
      operationId: get-bots
      parameters:
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: 'This parameter is used to order your results.

          If an order is not given, the default order id:asc will be applied.

          Possible ordering fields are properties.

          Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    post:
      tags:
      - customer-engagement
      summary: Create bot
      description: Use this method to create a bot. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#connect-external-bots-self-service-automation" target="_blank">More info</a>
      operationId: setup-bot
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Bot'
              examples:
                Successful bot setup.:
                  summary: Successful bot setup.
                  description: Successful bot setup.
                  value:
                    id: 309BB921757DEAC9BE79EC6259B31C8A
                    displayName: My Whatsapp Bot
                    webhookUrl: www.webhookurl.com/link1
                    destination: '447492263897'
                    channel: WHATSAPP
                    messagePersistencePolicy: PERSIST_ALL
                    enabled: true
                    sessionTimeoutInSec: 120
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/bots/{botId}:
    get:
      tags:
      - customer-engagement
      summary: Get bot
      description: Use this method to get a bot. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#connect-external-bots-self-service-automation" target="_blank">More info</a>
      operationId: get-bot
      parameters:
      - name: botId
        in: path
        description: Id of the Bot to get.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Bot'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 309BB921757DEAC9BE79EC6259B31C8A
                    displayName: My Whatsapp Bot
                    channel: WHATSAPP
                    destination: '447492263897'
                    messagePersistencePolicy: PERSIST_ALL
                    enabled: true
                    sessionTimeoutInSec: 120
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Update bot
      description: Use this method to update a bot. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#connect-external-bots-self-service-automation" target="_blank">More info</a>
      operationId: update-bot
      parameters:
      - name: botId
        in: path
        description: Id of the Bot being updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Bot'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 97457D13B1FC79AF3C1A1096AE7E77AB
                    displayName: New Whatsapp Bot
                    webhookUrl: www.newwebhookurl.com/newlink
                    destination: '447492263897'
                    channel: WHATSAPP
                    messagePersistencePolicy: PERSIST_ALL
                    enabled: false
                    sessionTimeoutInSec: 120
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    delete:
      tags:
      - customer-engagement
      summary: Delete bot
      description: 'Use this method to delete a bot.

        All open conversations assigned to a bot will be rerouted. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#connect-external-bots-self-service-automation" target="_blank">More info</a>'
      operationId: delete-bot
      parameters:
      - name: botId
        in: path
        description: Id of the Bot being deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Bot deleted successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/conversations/{conversationId}/metadata:
    get:
      tags:
      - customer-engagement
      summary: Get metadata
      description: Use this method to retrieve conversation metadata. <a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: get-metadata
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation to retrieve metadata for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
              examples:
                Get metadata.:
                  summary: Get metadata.
                  description: Get metadata.
                  value:
                    key1: value1
                    key2: value2
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Put metadata
      description: Use this method to create or update conversation metadata. Method overwrites old metadata. <a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: create-metadata
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation for which we are upserting metadata.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Metadata key-value pairs.
        content:
          application/json:
            schema:
              type: object
              minProperties: 1
            examples:
              Upsert metadata.:
                summary: Upsert metadata.
                description: Upsert metadata.
                value:
                  key1: value1
                  key2: value2
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Metadata added to conversation successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    delete:
      tags:
      - customer-engagement
      summary: Delete metadata
      description: Use this method to delete conversation metadata. <a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: delete-metadata
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation to delete metadata for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Metadata deleted successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    patch:
      tags:
      - customer-engagement
      summary: Patch metadata
      description: Use this method for metadata partial updating. If there is no present metadata, one will be created from request. <a href="https://www.infobip.com/docs/conversations-api" target="_blank">More info</a>
      operationId: patch-metadata
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation to update metadata for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Metadata key-value pairs.
        content:
          application/json:
            schema:
              type: object
              minProperties: 1
            examples:
              Patch metadata.:
                summary: Patch metadata.
                description: Patch metadata.
                value:
                  key1: value1_updated
                  key3: value3
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Metadata patch to conversation successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/templates:
    get:
      tags:
      - customer-engagement
      summary: Get templates
      description: 'Use this method to get a list of templates with pagination and filtering options. Using the filter is optional.

        The result can be filtered by one or many optional filters described in the parameters.

        Results are ordered by creation in descending order by default, meaning the newest template will be returned first.

        <a href="https://www.infobip.com/docs/conversations-api/templates" target="_blank">More info</a>'
      operationId: get-templates
      parameters:
      - name: channel
        in: query
        description: Optional. Template channel.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - SMS
          - VIBER
          - FACEBOOK_MESSENGER
          - WHATSAPP
          - RCS
          - EMAIL
          - LIVE_CHAT
          - APPLE_BUSINESS_CHAT
          - LINE
          - TELEGRAM
          - VIBER_BOT
          - FACEBOOK_POST
          - INSTAGRAM_POST
          - INSTAGRAM_MESSAGING
          - GOOGLE_PLAY
          - KAKAO_SANGDAM
      - name: language
        in: query
        description: Optional. Template language.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Afrikaans
          - Albanian
          - Arabic
          - Azerbaijani
          - Bengali
          - Bulgarian
          - Catalan
          - Chinese (CHN)
          - Chinese (HKG)
          - Chinese (TAI)
          - Croatian
          - Czech
          - Danish
          - Dutch
          - English
          - English (UK)
          - English (US)
          - Estonian
          - Filipino
          - Finnish
          - French
          - Georgian
          - German
          - Greek
          - Gujarati
          - Hausa
          - Hebrew
          - Hindi
          - Hungarian
          - Indonesian
          - Irish
          - Italian
          - Japanese
          - Kannada
          - Kazakh
          - Kinyarwanda
          - Korean
          - Kyrgyz (Kyrgyzstan)
          - Lao
          - Latvian
          - Lithuanian
          - Macedonian
          - Malay
          - Malayalam
          - Marathi
          - Norwegian
          - Persian
          - Polish
          - Portuguese (BR)
          - Portuguese (POR)
          - Punjabi
          - Romanian
          - Russian
          - Serbian
          - Slovak
          - Slovenian
          - Spanish
          - Spanish (ARG)
          - Spanish (SPA)
          - Spanish (MEX)
          - Swahili
          - Swedish
          - Tamil
          - Telugu
          - Thai
          - Turkish
          - Ukrainian
          - Urdu
          - Uzbek
          - Vietnamese
          - Zulu
      - name: createdAfter
        in: query
        description: 'Optional. Filter results created after specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdBefore
        in: query
        description: 'Optional. Filter results created before specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedAfter
        in: query
        description: 'Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedBefore
        in: query
        description: 'Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd''T''HH:mm:ss.SSS+0000'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: contentType
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateResultPage'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    templates:
                    - id: c4391685-b21a-4c21-a470-5453e9382752
                      name: First template name
                      language: English
                      languageCode: en
                      channel: SMS
                      external: false
                      content: Simple English text content
                      createdAt: '2024-01-01T00:00:00.000+00:00'
                      updatedAt: '2024-01-01T00:00:00.000+00:00'
                      tags:
                      - name: First template tag
                        createdAt: '2024-01-01T00:00:00.000+00:00'
                        updatedAt: '2024-01-01T00:00:00.000+00:00'
                      attachments: []
                    - id: e2fafe40-ea15-49c8-ae9b-aa07131a0096
                      name: Second template name
                      language: Spanish
                      languageCode: es
                      channel: SMS
                      external: false
                      content: Simple Spanish text content
                      createdAt: '2024-01-01T00:00:00.000+00:00'
                      updatedAt: '2024-01-01T00:00:00.000+00:00'
                      tags:
                      - name: Second template tag
                        createdAt: '2024-01-01T00:00:00.000+00:00'
                        updatedAt: '2024-01-01T00:00:00.000+00:00'
                      attachments:
                      - id: e2fafe40-ea15-49c8-ae9b-aa07131a0096
                        fileName: Second template file
                        fileExtension: txt
                        fileSize: 1024
                        contentType: text/plain
                        publicLink: https://example.com/second-template-file.txt
                        thumbLink: https://example.com/second-template-file-thumb.png
                        uploadedAt: '2024-01-01T00:00:00.000+00:00'
                      - id: e2fafe40-ea15-49c8-ae9b-aa07131a0096
                        fileName: Second template image
                        fileExtension: png
                        fileSize: 2048
                        contentType: image/png
                        publicLink: https://example.com/second-template-image.png
                        thumbLink: https://example.com/second-template-image-thumb.png
                        uploadedAt: '2024-01-01T00:00:00.000+00:00'
                    pagination:
                      totalItems: 2
                      page: 0
                      limit: 10
                      orderBy: createdAt:DESC
        '400':
          description: BAD REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-is-early-access: true
  /ccaas/1/templates/{templateId}:
    get:
      tags:
      - customer-engagement
      summary: Get template
      description: Use this method to get a single template. <a href="https://www.infobip.com/docs/conversations-api/templates" target="_blank">More info</a>
      operationId: get-template
      parameters:
      - name: templateId
        in: path
        description: Id of the template to get.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: c4391685-b21a-4c21-a470-5453e9382752
                    name: Template name
                    language: English
                    languageCode: en
                    channel: SMS
                    external: false
                    content: Simple text content
                    createdAt: '2024-01-01T00:00:00.000+00:00'
                    updatedAt: '2024-01-01T00:00:00.000+00:00'
                    tags:
                    - name: Template tag
                      createdAt: '2024-12-10T00:00:00.000+00:00'
                      updatedAt: '2024-12-10T00:00:00.000+00:00'
                    attachments: []
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-is-early-access: true
  /ccaas/2/conversation-forms/forms:
    get:
      tags:
      - customer-engagement
      summary: Get conversation forms
      description: Use this method to get a list of forms with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters.
      operationId: get-conversation-forms
      parameters:
      - name: title
        in: query
        description: Optional filter. Form title.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: isEnabled
        in: query
        description: Optional filter. Enabled status.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: isDefault
        in: query
        description: Optional filter. Default status.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    post:
      tags:
      - customer-engagement
      summary: Create conversation form
      description: Use this method to create a form.
      operationId: create-conversation-form
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormRequest'
            examples:
              Creating form with simple field.:
                summary: Creating form with simple field.
                description: Creating form with simple field.
                value:
                  title: Granulation
                  isEnabled: true
                  fields:
                  - fieldId: ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc
                    isRequired: false
              Creating form with field containing conditionals.:
                summary: Creating form with field containing conditionals.
                description: Creating form with field containing conditionals.
                value:
                  title: Granulation
                  isEnabled: true
                  fields:
                  - fieldId: d85b8e46-f579-482f-b383-22648aae17b5
                    isRequired: false
                    conditions:
                    - value: complaint
                      conditionalFields:
                      - fieldId: e130e3f2-c8de-4ba9-a26e-8ac705642832
                        isRequired: false
                    - value: inquiry
                      conditionalFields:
                      - fieldId: ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc
                        isRequired: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form'
              examples:
                Successful response form with simple field:
                  summary: Successful response form with simple field
                  description: Successful response form with simple field
                  value:
                    id: 75f57446-1d65-478a-87ed-22d17dc3d077
                    title: Granulation
                    isEnabled: true
                    isDefault: false
                    fields:
                    - field:
                        id: ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc
                        title: Inquiry
                        type: TEXT
                        isEnabled: true
                        isDefault: null
                        options: []
                        createdAt: '2021-06-29T10:00:16.692653Z'
                        updatedAt: '2021-06-29T10:00:16.692654Z'
                        operators: []
                      isRequired: false
                      conditions: []
                    createdAt: '2021-06-29T10:01:11.633649Z'
                    updatedAt: '2021-06-29T10:01:11.633650Z'
                Successful response form with field containing conditionals:
                  summary: Successful response form with field containing conditionals
                  description: Successful response form with field containing conditionals
                  value:
                    id: 75f57446-1d65-478a-87ed-22d17dc3d077
                    title: Granulation
                    isEnabled: true
                    isDefault: false
                    fields:
                    - field:
                        id: d85b8e46-f579-482f-b383-22648aae17b5
                        title: Type
                        type: DROPDOWN
                        isEnabled: true
                        isDefault: null
                        options:
                        - inquiry
                        - complaint
                        createdAt: '2021-06-29T10:00:16.692653Z'
                        updatedAt: '2021-06-29T10:00:16.692654Z'
                        operators: []
                      isRequired: false
                      conditions:
                      - id: 44982f5d-07ce-4c2e-88a8-6694fc598f21
                        value: complaint
                        fields:
                        - field:
                            id: e130e3f2-c8de-4ba9-a26e-8ac705642832
                            title: Complaints
                            type: TEXT
                            isEnabled: true
                            isDefault: null
                            options: []
                            createdAt: '2021-06-29T10:00:55.755685Z'
                            updatedAt: '2021-06-29T10:00:55.755686Z'
                            operators: []
                          isRequired: false
                      - id: 57bf2c95-c318-4c5a-9e03-a98193b178ae
                        value: inquiry
                        fields:
                        - field:
                            id: ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc
                            title: Inquiry
                            type: TEXT
                            isEnabled: true
                            isDefault: null
                            options: []
                            createdAt: '2021-06-29T10:00:33.777564Z'
                            updatedAt: '2021-06-29T10:00:33.777565Z'
                            operators: []
                          isRequired: false
                    createdAt: '2021-06-29T10:01:11.633649Z'
                    updatedAt: '2021-06-29T10:01:11.633650Z'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid field id:
                  summary: Invalid field id
                  description: Invalid field id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc given! No such field exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/2/conversation-forms/forms/{id}:
    get:
      tags:
      - customer-engagement
      summary: Get conversation form
      description: 'Use this method to get a single form. '
      operationId: get-conversation-form
      parameters:
      - name: id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 75f57446-1d65-478a-87ed-22d17dc3d077
                    title: Granulation
                    isEnabled: true
                    isDefault: false
                    fields:
                    - field:
                        id: d85b8e46-f579-482f-b383-22648aae17b5
                        title: Type
                        type: DROPDOWN
                        isEnabled: true
                        isDefault: false
                        options:
                        - inquiry
                        - complaint
                        createdAt: '2021-06-29T10:00:16.692653Z'
                        updatedAt: '2021-06-29T10:00:16.692654Z'
                        operators: []
                      isRequired: true
                      conditions: []
                    createdAt: '2021-06-29T10:01:11.633649Z'
                    updatedAt: '2021-06-29T10:01:11.633650Z'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Update conversation form
      description: Use this method to update a form.
      operationId: update-conversation-form
      parameters:
      - name: id
        in: path
        description: Id of the form to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  title: Granulation
                  isEnabled: true
                  isDefault: false
                  fields:
                  - fieldId: ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc
                    isRequired: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 75f57446-1d65-478a-87ed-22d17dc3d077
                    title: Granulation
                    isEnabled: true
                    isDefault: false
                    fields:
                    - field:
                        id: d85b8e46-f579-482f-b383-22648aae17b5
                        title: Type
                        type: DROPDOWN
                        isEnabled: true
                        isDefault: false
                        options:
                        - inquiry
                        - complaint
                        createdAt: '2021-06-29T10:00:16.692653Z'
                        updatedAt: '2021-06-29T10:00:16.692654Z'
                        operators: []
                      isRequired: true
                      conditions: []
                    createdAt: '2021-06-29T10:01:11.633649Z'
                    updatedAt: '2021-06-29T10:01:11.633650Z'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid form id or field id:
                  summary: Invalid form id or field id
                  description: Invalid form id or field id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    delete:
      tags:
      - customer-engagement
      summary: Delete conversation form
      description: Use this method to delete the form.
      operationId: delete-conversation-form
      parameters:
      - name: id
        in: path
        description: Id of the form to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Form deleted successfully.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/2/conversation-forms/fields:
    get:
      tags:
      - customer-engagement
      summary: Get fields
      description: Use this method to get a list of fields with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters.
      operationId: get-conversation-form-fields
      parameters:
      - name: title
        in: query
        description: Optional filter. Field title.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    post:
      tags:
      - customer-engagement
      summary: Create field
      description: Use this method to create a field.
      operationId: create-conversation-form-field
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldRequest'
            examples:
              Creating field of TEXT type.:
                summary: Creating field of TEXT type.
                description: Creating field of TEXT type.
                value:
                  title: Inquiry
                  type: TEXT
              Creating field of DROPDOWN type.:
                summary: Creating field of DROPDOWN type.
                description: Creating field of DROPDOWN type.
                value:
                  title: Type
                  type: DROPDOWN
                  options:
                  - inquiry
                  - complaint
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field'
              examples:
                Successful response for field of TEXT type:
                  summary: Successful response for field of TEXT type
                  description: Successful response for field of TEXT type
                  value:
                    id: ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc
                    title: Inquiry
                    type: TEXT
                    regex: null
                    isEnabled: true
                    options: []
                    createdAt: '2021-06-29T10:00:55.755685Z'
                    updatedAt: '2021-06-29T10:00:55.755686Z'
                    operators: []
                Successful response for field of DROPDOWN type:
                  summary: Successful response for field of DROPDOWN type
                  description: Successful response for field of DROPDOWN type
                  value:
                    id: d85b8e46-f579-482f-b383-22648aae17b5
                    title: Type
                    type: DROPDOWN
                    regex: null
                    isEnabled: true
                    options:
                    - inquiry
                    - complaint
                    createdAt: '2021-06-29T10:00:55.755685Z'
                    updatedAt: '2021-06-29T10:00:55.755686Z'
                    operators: []
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/2/conversation-forms/fields/{id}:
    get:
      tags:
      - customer-engagement
      summary: Get field
      description: 'Use this method to get a single field. '
      operationId: get-conversation-form-field
      parameters:
      - name: id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc
                    title: Inquiry
                    type: TEXT
                    regex: null
                    isEnabled: true
                    isDefault: null
                    options: []
                    createdAt: '2021-06-29T10:00:33.777564Z'
                    updatedAt: '2021-06-29T10:00:33.777565Z'
                    operators: []
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid field id:
                  summary: Invalid field id
                  description: Invalid field id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc given! No such field exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Update field
      description: Use this method to update a field.
      operationId: update-conversation-form-field
      parameters:
      - name: id
        in: path
        description: Id of the field being updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldRequest'
            examples:
              Updating field.:
                summary: Updating field.
                description: Updating field.
                value:
                  title: Type
                  enabled: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: d85b8e46-f579-482f-b383-22648aae17b5
                    title: Type
                    type: DROPDOWN
                    regex: null
                    isEnabled: false
                    options:
                    - inquiry
                    - complaint
                    createdAt: '2021-06-29T10:00:55.755685Z'
                    updatedAt: '2021-06-29T10:00:55.755686Z'
                    operators: []
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid field id:
                  summary: Invalid field id
                  description: Invalid field id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc given! No such field exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    delete:
      tags:
      - customer-engagement
      summary: Delete field
      description: "Use this method to delete the field. \nDeleting a field will remove associated agent inputs in all non-closed conversations. This operation cannot be reverted!"
      operationId: delete-conversation-form-field
      parameters:
      - name: id
        in: path
        description: Id of the field being deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Field deleted successfully.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc given! No such field exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/2/conversation-forms/triggers:
    get:
      tags:
      - customer-engagement
      summary: Get triggers
      description: Use this method to get a list of triggers with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filter described in the parameters.
      operationId: get-conversation-form-triggers
      parameters:
      - name: title
        in: query
        description: Optional filter. Trigger title.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.TriggerResultPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    post:
      tags:
      - customer-engagement
      summary: Create trigger
      description: "The create trigger method creates a new trigger at the first order position in the existing setup. Triggers are used to assign proper form to a conversation, based on an expression. Every expression can be constructed with at least one or more available operators. The result of the expression will be a success (TRUE) only if all results of operations are TRUE. Order of triggers is essential in the form assignment process, as triggers are match the provided order. First trigger matching the conversation will be used. \n <a href=\"https://www.infobip.com/docs/conversations/supervisor-guide\" target=\"_blank\">More info</a>"
      operationId: create-conversation-form-trigger
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger'
            examples:
              Creating trigger:
                summary: Creating trigger
                description: Creating trigger
                value:
                  title: AJ Queue
                  expression:
                    $neq:
                      queue: AJ Queue
                  isEnabled: true
                  formId: 75f57446-1d65-478a-87ed-22d17dc3d077
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: b3695d3c-6415-4bdd-82fc-07f9309933ec
                    title: AJ Queue
                    expression:
                      $neq:
                        queue: AJ Queue
                    orderIndex: 0
                    isEnabled: true
                    formId: 75f57446-1d65-478a-87ed-22d17dc3d077
                    timesTriggered: 0
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid form id:
                  summary: Invalid form id
                  description: Invalid form id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/2/conversation-forms/triggers/{id}:
    get:
      tags:
      - customer-engagement
      summary: Get trigger
      description: 'Use this method to get a single trigger. '
      operationId: get-conversation-form-trigger
      parameters:
      - name: id
        in: path
        description: Id of the trigger.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: b3695d3c-6415-4bdd-82fc-07f9309933ec
                    title: AJ Queue
                    expression:
                      $neq:
                        queue: AJ Queue
                    orderIndex: 0
                    isEnabled: true
                    formId: 75f57446-1d65-478a-87ed-22d17dc3d077
                    timesTriggered: 0
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id b3695d3c-6415-4bdd-82fc-07f9309933ec given! No such trigger exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Update trigger
      description: Use this method to update a trigger. Triggers between 'old' and 'new' position will be set automatically ± one position. <a href="https://www.infobip.com/docs/conversations/supervisor-guide" target="_blank">More info</a>
      operationId: update-conversation-form-trigger
      parameters:
      - name: id
        in: path
        description: Id of the trigger to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger'
            examples:
              Updating trigger:
                summary: Updating trigger
                description: Updating trigger
                value:
                  title: AJ Queue
                  expression:
                    $neq:
                      queue: AJ Queue
                  orderIndex: 2
                  isEnabled: true
                  formId: 75f57446-1d65-478a-87ed-22d17dc3d077
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: b3695d3c-6415-4bdd-82fc-07f9309933ec
                    title: AJ Queue
                    expression:
                      $neq:
                        queue: AJ Queue
                    orderIndex: 2
                    isEnabled: true
                    formId: 75f57446-1d65-478a-87ed-22d17dc3d077
                    timesTriggered: 0
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid form id:
                  summary: Invalid form id
                  description: Invalid form id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    delete:
      tags:
      - customer-engagement
      summary: Delete trigger
      description: Use this method to delete a trigger.
      operationId: delete-conversation-form-trigger
      parameters:
      - name: id
        in: path
        description: Id of the trigger to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Trigger deleted successfully.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id b3695d3c-6415-4bdd-82fc-07f9309933ec given! No such trigger exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    patch:
      tags:
      - customer-engagement
      summary: Patch trigger
      description: "Use this method to patch a trigger. Triggers between 'old' and 'new' position will be set automatically ± one position.\n <a href=\"https://www.infobip.com/docs/conversations/supervisor-guide\" target=\"_blank\">More info</a>"
      operationId: patch-conversation-form-trigger
      parameters:
      - name: id
        in: path
        description: Id of the trigger to patch.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger'
            examples:
              Patching trigger:
                summary: Patching trigger
                description: Patching trigger
                value:
                  orderIndex: 2
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: b3695d3c-6415-4bdd-82fc-07f9309933ec
                    title: AJ Queue
                    expression:
                      $neq:
                        queue: AJ Queue
                    orderIndex: 2
                    isEnabled: true
                    formId: 75f57446-1d65-478a-87ed-22d17dc3d077
                    timesTriggered: 0
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid form id:
                  summary: Invalid form id
                  description: Invalid form id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/2/conversations/{conversationId}/form:
    get:
      tags:
      - customer-engagement
      summary: Get dispositions
      description: 'Use this method to get a conversation form with attached fields and values. '
      operationId: get-conversation-form-dispositions
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: formId
        in: query
        description: Id of the form. If none provided, the one currently assigned to a conversation is used.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.DispositionBasic'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    conversationId: F876A7C5C73A1B3CA94FE405DF30D0A2
                    formId: 75f57446-1d65-478a-87ed-22d17dc3d077
                    fields:
                    - fieldId: d85b8e46-f579-482f-b383-22648aae17b5
                      dispositionId: d7a2980d-5496-44aa-8046-bf2233e7999f
                      dispositionValue: inquiry
                    - fieldId: e130e3f2-c8de-4ba9-a26e-8ac705642832
                      dispositionId: 8f7faac9-742c-42d6-bac7-c8a63f587e57
                      dispositionValue: null
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                No dispositions:
                  summary: No dispositions
                  description: No dispositions
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: No dispositions for conversationId F876A7C5C73A1B3CA94FE405DF30D0A2 and formId 75f57446-1d65-478a-87ed-22d17dc3d077.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Update or insert dispositions
      description: Use this method to create or update field value for a conversation. Method overwrites old dispositions.
      operationId: upsert-conversation-form-dispositions
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.UpsertDispositionApiRequest'
            examples:
              Disposition insert or update:
                summary: Disposition insert or update
                description: Disposition insert or update
                value:
                  fields:
                  - fieldId: ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc
                    value: updating an existing disposition
                  - fieldId: d85b8e46-f579-482f-b383-22648aae17b5
                    value: creating a new disposition
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Disposition updated successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Required request body is missing or not valid.
                Closed conversation:
                  summary: Closed conversation
                  description: Closed conversation
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Can not proceed with the action! Conversation is closed.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid conversation id:
                  summary: Invalid conversation id
                  description: Invalid conversation id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 0006D2EC59B1DEB114FE3931FC365F29 given! No such conversation exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/2/conversations/{conversationId}/form/{id}:
    delete:
      tags:
      - customer-engagement
      summary: Delete disposition
      description: Use this method to delete an agent input to a field from a conversation.
      operationId: delete-conversation-form-disposition
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: Id of the disposition being deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Disposition deleted successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Closed conversation:
                  summary: Closed conversation
                  description: Closed conversation
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Can not proceed with the action! Conversation is closed.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid conversation id:
                  summary: Invalid conversation id
                  description: Invalid conversation id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 0006D2EC59B1DEB114FE3931FC365F29 given! No such conversation exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/2/conversations/{conversationId}/form/assign:
    post:
      tags:
      - customer-engagement
      summary: Assign form to conversation
      description: 'Use this method to assign form to a conversation. '
      operationId: assign-conversation-form
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: formId
        in: query
        description: Id of the form to assign.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Form successfully assigned.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Disabled form:
                  summary: Disabled form
                  description: Disabled form
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Can not proceed with the action! Form 75f57446-1d65-478a-87ed-22d17dc3d077 is disabled.
                Closed conversation:
                  summary: Closed conversation
                  description: Closed conversation
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Can not proceed with the action! Conversation is closed.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid conversation id:
                  summary: Invalid conversation id
                  description: Invalid conversation id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 0006D2EC59B1DEB114FE3931FC365F29 given! No such conversation exists.
                Invalid form id:
                  summary: Invalid form id
                  description: Invalid form id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/2/conversations/{conversationId}/form/unassign:
    post:
      tags:
      - customer-engagement
      summary: Un-assign form from conversation
      description: Use this method to remove a form from a given conversation. Un-assign is implemented by setting the formId property of the Conversation to null.
      operationId: un-assign-conversation-form
      parameters:
      - name: conversationId
        in: path
        description: Id of the conversation.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Form successfully un-assigned.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Closed conversation:
                  summary: Closed conversation
                  description: Closed conversation
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Can not proceed with the action! Conversation is closed.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse'
              examples:
                Invalid conversation id:
                  summary: Invalid conversation id
                  description: Invalid conversation id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 0006D2EC59B1DEB114FE3931FC365F29 given! No such conversation exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/account/configuration:
    put:
      tags:
      - customer-engagement
      summary: Update account configuration
      description: This endpoint is deprecated as of March 12, 2025, meaning no fixes or updates will be provided. It will be completely removed on December 31, 2026. Configure the webhooks through the <a href="https://www.infobip.com/docs/conversations-api" target="_blank">Subscription management</a> section in your Infobip account or the existing <a href="https://www.infobip.com/docs/api/platform/subscriptions-api" target="_blank">Subscriptions management API</a>.
      operationId: update-conversation-account-configuration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AccountConfigurationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Account configuration successfully updated.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccca/1/agent-configs/{agentId}:
    get:
      tags:
      - customer-engagement
      summary: Get agent configuration
      description: Use this method to retrieve the current agent-specific configuration.
      operationId: get-conversations-agent-config
      parameters:
      - name: agentId
        in: path
        description: Agent ID used to retrieve the configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    wrapUpSeconds: 30
                    backgroundBlurSettings:
                      mode: VIRTUAL_BACKGROUND
                      fileMetadata:
                        fileId: 91184DE7-92BF-4F94-875C-8E701AE71DF9
                        fileName: background.jpg
                        fileSize: 3605569
                        fileUrl: https://file.cloudfront.net/client-contact-center-background-images/someImageUrl
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/outbound-call-conversation:
    post:
      tags:
      - customer-engagement
      summary: Create outbound call conversation
      description: "Use this method to create a conversation associated with an outbound call. Expected usage is to trigger this endpoint and then start a call using the RTC SDK callConversations method. The created conversation ID is required when using the callConversations method to trigger an outbound call. Another option is to use the ID of a previously created call conversation. <a href=\"https://www.infobip.com/docs/conversations/calls#make-a-call-agent-guide\"\n target=\"_blank\">More info</a>."
      operationId: create-conversation-outbound-call
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OutboundCallConversationRequestApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OutboundCallConversationResponseApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    from: '385998779621'
                    to: '38761123333'
                    conversationId: 718A037A2FE0D2D5AA2D12A7240ED8C4
                    agentId: 2010EA93ABC142E812C19F529BCBD22F
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Missing parameter:
                  summary: Missing parameter
                  description: Missing parameter
                  value:
                    status: ERROR
                    message: 'to: Param TO must have non blank value'
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    status: ERROR
                    message: No agent found with id=E5FB76C90DD4203DF04364004843BAFC
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/voice/2/waiting-strategies:
    get:
      tags:
      - customer-engagement
      summary: Get all waiting strategies
      description: Use this method to retrieve all waiting strategies. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#waiting-strategy-digital-channels" target="_blank">More info</a>.
      operationId: get-conversations-waiting-strategies
      parameters:
      - name: queueId
        in: query
        description: Optional filter. Queue id.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: Optional filter. Page number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: pageSize
        in: query
        description: Optional filter. Page size.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: sortDirection
        in: query
        description: Optional filter. This parameter is used to order your results. If an order is not given, the default order DESC will be applied. Supported values are ASC and DESC.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: Optional filter. This parameter is used to specify sort criteria. If a criteria is not given, the default criteria CREATED_AT will be applied. Supported values are NAME and CREATED_AT.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    elements:
                    - id: e2cea358-0347-4d23-9d82-af00f8f5c5b2
                      name: Test Sender Waiting Strategy
                      maximumWaitTime:
                        unit: SECONDS
                        value: 5
                      greetingMessage:
                        enabled: true
                        audioSourceType: TTS
                        ttsAudioSource:
                          text: Greetings!
                          language: en-gb
                          voice:
                            name: Emma
                            gender: FEMALE
                          speechRate: 1.0
                        fileAudioSource: null
                      musicOnHold:
                        enabled: false
                        fileAudioSource: null
                      announcementMessage:
                        enabled: true
                        audioSourceType: TTS
                        ttsAudioSource:
                          text: Greetings!
                          language: en-gb
                          voice:
                            name: Emma
                            gender: FEMALE
                          speechRate: 1.0
                        fileAudioSource: null
                        repeatInterval:
                          unit: SECONDS
                          value: 3
                      maximumWaitTimeMessage:
                        enabled: true
                        audioSourceType: TTS
                        ttsAudioSource:
                          text: Greetings!
                          language: en-gb
                          voice:
                            name: Emma
                            gender: FEMALE
                          speechRate: 1.0
                        fileAudioSource: null
                      senders:
                      - clientType: PSTN
                        identifier: '123456789'
                      - clientType: WEBRTC
                        identifier: conversations
                      conditionType: SENDER
                      condition:
                        senders:
                        - clientType: PSTN
                          identifier: '123456789'
                        - clientType: WEBRTC
                          identifier: conversations
                      createdAt: 2022-12-10T13:45:00.777+0000
                      updatedAt: 2022-12-10T13:45:00.777+0000
                    - id: 25774a87-078a-4fe7-8d43-127809479964
                      name: Test Queue Waiting Strategy
                      maximumWaitTime:
                        unit: SECONDS
                        value: 5
                      greetingMessage:
                        enabled: true
                        audioSourceType: TTS
                        ttsAudioSource:
                          text: Greetings!
                          language: en-gb
                          voice:
                            name: Emma
                            gender: FEMALE
                          speechRate: 1.0
                        fileAudioSource: null
                      musicOnHold:
                        enabled: false
                        fileAudioSource: null
                      announcementMessage:
                        enabled: true
                        audioSourceType: TTS
                        ttsAudioSource:
                          text: Greetings!
                          language: en-gb
                          voice:
                            name: Emma
                            gender: FEMALE
                          speechRate: 1.0
                        fileAudioSource: null
                        repeatInterval:
                          unit: SECONDS
                          value: 3
                      maximumWaitTimeMessage:
                        enabled: true
                        audioSourceType: TTS
                        ttsAudioSource:
                          text: Greetings!
                          language: en-gb
                          voice:
                            name: Emma
                            gender: FEMALE
                          speechRate: 1.0
                        fileAudioSource: null
                      senders: []
                      conditionType: QUEUE
                      condition:
                        queues:
                        - e80552ae-d8e6-4123-93a3-35e7721d1cdd
                        - default
                      createdAt: 2022-12-10T13:45:00.777+0000
                      updatedAt: 2022-12-10T13:45:00.777+0000
                    total: 2
                    totalPages: 1
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    post:
      tags:
      - customer-engagement
      summary: Create waiting strategy
      description: Use this method to add a new waiting strategy. To upload an audio file and get value for fileDescriptor field, use <a href="https://www.infobip.com/docs/api#customer-engagement/anonymize/upload-audio-files" target="_blank">Upload audio files endpoint</a>. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#waiting-strategy-digital-channels" target="_blank">More info</a>.
      operationId: create-conversations-waiting-strategy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiRequest'
            examples:
              Create sender-based waiting strategy.:
                summary: Create sender-based waiting strategy.
                description: Create sender-based waiting strategy.
                value:
                  name: Test Sender Waiting Strategy
                  maximumWaitTime:
                    unit: SECONDS
                    value: 5
                  greetingMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                  musicOnHold:
                    enabled: false
                    fileAudioSource: null
                  announcementMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                    repeatInterval:
                      unit: SECONDS
                      value: 3
                  maximumWaitTimeMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                  conditionType: SENDER
                  condition:
                    senders:
                    - clientType: PSTN
                      identifier: '123456789'
                    - clientType: WEBRTC
                      identifier: conversations
              Create queue-based waiting strategy.:
                summary: Create queue-based waiting strategy.
                description: Create queue-based waiting strategy.
                value:
                  name: Test Queue Waiting Strategy
                  maximumWaitTime:
                    unit: SECONDS
                    value: 5
                  greetingMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                  musicOnHold:
                    enabled: false
                    fileAudioSource: null
                  announcementMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                    repeatInterval:
                      unit: SECONDS
                      value: 3
                  maximumWaitTimeMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                  conditionType: QUEUE
                  condition:
                    queues:
                    - e80552ae-d8e6-4123-93a3-35e7721d1cdd
                    - default
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse'
              examples:
                Response for successfully creating a sender-based waiting strategy.:
                  summary: Response for successfully creating a sender-based waiting strategy.
                  description: Response for successfully creating a sender-based waiting strategy.
                  value:
                    id: e2cea358-0347-4d23-9d82-af00f8f5c5b2
                    name: Test Sender Waiting Strategy
                    maximumWaitTime:
                      unit: SECONDS
                      value: 5
                    greetingMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    musicOnHold:
                      enabled: false
                      fileAudioSource: null
                    announcementMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                      repeatInterval:
                        unit: SECONDS
                        value: 3
                    maximumWaitTimeMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    senders:
                    - clientType: PSTN
                      identifier: '123456789'
                    - clientType: WEBRTC
                      identifier: conversations
                    conditionType: SENDER
                    condition:
                      senders:
                      - clientType: PSTN
                        identifier: '123456789'
                      - clientType: WEBRTC
                        identifier: conversations
                    createdAt: 2022-12-10T13:45:00.777+0000
                    updatedAt: 2022-12-10T13:45:00.777+0000
                Response for successfully creating a queue-based waiting strategy.:
                  summary: Response for successfully creating a queue-based waiting strategy.
                  description: Response for successfully creating a queue-based waiting strategy.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    name: Test Queue Waiting Strategy
                    maximumWaitTime:
                      unit: SECONDS
                      value: 5
                    greetingMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    musicOnHold:
                      enabled: false
                      fileAudioSource: null
                    announcementMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                      repeatInterval:
                        unit: SECONDS
                        value: 3
                    maximumWaitTimeMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    senders: []
                    conditionType: QUEUE
                    condition:
                      queues:
                      - e80552ae-d8e6-4123-93a3-35e7721d1cdd
                      - default
                    createdAt: 2022-12-10T13:45:00.777+0000
                    updatedAt: 2022-12-10T13:45:00.777+0000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Missing maximum wait time:
                  summary: Missing maximum wait time
                  description: Missing maximum wait time
                  value:
                    status: ERROR
                    message: 'maximumWaitTime: Missing Maximum Wait Time'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/waiting-strategies/{id}:
    get:
      tags:
      - customer-engagement
      summary: Get waiting strategy
      description: Use this method to retrieve a waiting strategy by its Id. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#waiting-strategy-digital-channels" target="_blank">More info</a>.
      operationId: get-conversations-waiting-strategy
      parameters:
      - name: id
        in: path
        description: Id of the Waiting Strategy to get.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse'
              examples:
                Response for successfully retrieving a sender-based waiting strategy.:
                  summary: Response for successfully retrieving a sender-based waiting strategy.
                  description: Response for successfully retrieving a sender-based waiting strategy.
                  value:
                    id: e2cea358-0347-4d23-9d82-af00f8f5c5b2
                    name: Test Sender Waiting Strategy
                    maximumWaitTime:
                      unit: SECONDS
                      value: 5
                    greetingMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    musicOnHold:
                      enabled: false
                      fileAudioSource: null
                    announcementMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                      repeatInterval:
                        unit: SECONDS
                        value: 3
                    maximumWaitTimeMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    senders:
                    - clientType: PSTN
                      identifier: '123456789'
                    - clientType: WEBRTC
                      identifier: conversations
                    conditionType: SENDER
                    condition:
                      senders:
                      - clientType: PSTN
                        identifier: '123456789'
                      - clientType: WEBRTC
                        identifier: conversations
                    createdAt: 2022-12-10T13:45:00.777+0000
                    updatedAt: 2022-12-10T13:45:00.777+0000
                Response for successfully retrieving a queue-based waiting strategy.:
                  summary: Response for successfully retrieving a queue-based waiting strategy.
                  description: Response for successfully retrieving a queue-based waiting strategy.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    name: Test Queue Waiting Strategy
                    maximumWaitTime:
                      unit: SECONDS
                      value: 5
                    greetingMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    musicOnHold:
                      enabled: false
                      fileAudioSource: null
                    announcementMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                      repeatInterval:
                        unit: SECONDS
                        value: 3
                    maximumWaitTimeMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    senders: []
                    conditionType: QUEUE
                    condition:
                      queues:
                      - e80552ae-d8e6-4123-93a3-35e7721d1cdd
                      - default
                    createdAt: 2022-12-10T13:45:00.777+0000
                    updatedAt: 2022-12-10T13:45:00.777+0000
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    put:
      tags:
      - customer-engagement
      summary: Update waiting strategy
      description: Use this method to update a waiting strategy. To upload an audio file and get value for fileDescriptor field, use <a href="https://www.infobip.com/docs/api#customer-engagement/anonymize/upload-audio-files" target="_blank">Upload audio files endpoint</a>. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#waiting-strategy-digital-channels" target="_blank">More info</a>.
      operationId: update-conversations-waiting-strategy
      parameters:
      - name: id
        in: path
        description: Id of the Waiting Strategy being updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiRequest'
            examples:
              Update sender-based waiting strategy.:
                summary: Update sender-based waiting strategy.
                description: Update sender-based waiting strategy.
                value:
                  name: Test Sender Waiting Strategy
                  maximumWaitTime:
                    unit: SECONDS
                    value: 5
                  greetingMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                  musicOnHold:
                    enabled: false
                    fileAudioSource: null
                  announcementMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                    repeatInterval:
                      unit: SECONDS
                      value: 3
                  maximumWaitTimeMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                  conditionType: SENDER
                  condition:
                    senders:
                    - clientType: PSTN
                      identifier: '123456789'
                    - clientType: WEBRTC
                      identifier: conversations
              Update queue-based waiting strategy.:
                summary: Update queue-based waiting strategy.
                description: Update queue-based waiting strategy.
                value:
                  name: Test Queue Waiting Strategy
                  maximumWaitTime:
                    unit: SECONDS
                    value: 5
                  greetingMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                  musicOnHold:
                    enabled: false
                    fileAudioSource: null
                  announcementMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                    repeatInterval:
                      unit: SECONDS
                      value: 3
                  maximumWaitTimeMessage:
                    enabled: true
                    audioSourceType: TTS
                    ttsAudioSource:
                      text: Greetings!
                      language: en-gb
                      voice:
                        name: Emma
                        gender: FEMALE
                      speechRate: 1.0
                    fileAudioSource: null
                  conditionType: QUEUE
                  condition:
                    queues:
                    - e80552ae-d8e6-4123-93a3-35e7721d1cdd
                    - default
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse'
              examples:
                Response for successfully updating a sender-based waiting strategy.:
                  summary: Response for successfully updating a sender-based waiting strategy.
                  description: Response for successfully updating a sender-based waiting strategy.
                  value:
                    id: e2cea358-0347-4d23-9d82-af00f8f5c5b2
                    name: Test Sender Waiting Strategy
                    maximumWaitTime:
                      unit: SECONDS
                      value: 5
                    greetingMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    musicOnHold:
                      enabled: false
                      fileAudioSource: null
                    announcementMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                      repeatInterval:
                        unit: SECONDS
                        value: 3
                    maximumWaitTimeMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    senders:
                    - clientType: PSTN
                      identifier: '123456789'
                    - clientType: WEBRTC
                      identifier: conversations
                    conditionType: SENDER
                    condition:
                      senders:
                      - clientType: PSTN
                        identifier: '123456789'
                      - clientType: WEBRTC
                        identifier: conversations
                    createdAt: 2022-12-10T13:45:00.777+0000
                    updatedAt: 2022-12-10T13:45:00.777+0000
                Response for successfully updating a queue-based waiting strategy.:
                  summary: Response for successfully updating a queue-based waiting strategy.
                  description: Response for successfully updating a queue-based waiting strategy.
                  value:
                    id: 25774a87-078a-4fe7-8d43-127809479964
                    name: Test Queue Waiting Strategy
                    maximumWaitTime:
                      unit: SECONDS
                      value: 5
                    greetingMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    musicOnHold:
                      enabled: false
                      fileAudioSource: null
                    announcementMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                      repeatInterval:
                        unit: SECONDS
                        value: 3
                    maximumWaitTimeMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Greetings!
                        language: en-gb
                        voice:
                          name: Emma
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                    senders: []
                    conditionType: QUEUE
                    condition:
                      queues:
                      - e80552ae-d8e6-4123-93a3-35e7721d1cdd
                      - default
                    createdAt: 2022-12-10T13:45:00.777+0000
                    updatedAt: 2022-12-10T13:45:00.777+0000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Missing maximum wait time:
                  summary: Missing maximum wait time
                  description: Missing maximum wait time
                  value:
                    status: ERROR
                    message: 'maximumWaitTime: Missing Maximum Wait Time'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    delete:
      tags:
      - customer-engagement
      summary: Delete waiting strategy
      description: Use this method to delete a waiting strategy by its Id. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#waiting-strategy-digital-channels" target="_blank">More info</a>.
      operationId: delete-conversations-waiting-strategy
      parameters:
      - name: id
        in: path
        description: Id of the Waiting Strategy being deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: SUCCESS
                    message: Waiting Strategy deleted.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Waiting strategy not found:
                  summary: Waiting strategy not found
                  description: Waiting strategy not found
                  value:
                    status: ERROR
                    message: 'No record found with WS Id: e2cea358-0347-4d23-9d82-af00f8f5c5b2'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 100
  /ccaas/voice/2/account-recording-config:
    get:
      tags:
      - customer-engagement
      summary: Get account recording configuration
      description: Use this method to retrieve the account recording configuration. <a href="https://www.infobip.com/docs/conversations/calls#recording-set-up-calls" target="_blank">More info</a>.
      operationId: get-conversations-account-recording-config
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    inbound: true
                    outbound: true
                    autoCompose: false
                    mediaType: AUDIO_AND_VIDEO
                    videoDownloadPreparation: false
                    enabled: true
                    enabledChangedAt: 1622024333000
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    put:
      tags:
      - customer-engagement
      summary: Update account recording configuration
      description: Use this method to create or update an account recording configuration. <a href="https://www.infobip.com/docs/conversations/calls#recording-set-up-calls" target="_blank">More info</a>.
      operationId: update-conversations-account-recording-config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    inbound: true
                    outbound: true
                    autoCompose: false
                    mediaType: AUDIO_AND_VIDEO
                    videoDownloadPreparation: false
                    enabled: true
                    enabledChangedAt: 1622024333000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Missing Media Type:
                  summary: Missing Media Type
                  description: Missing Media Type
                  value:
                    status: ERROR
                    message: 'mediaType: Missing Media Type'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    post:
      tags:
      - customer-engagement
      summary: Create account recording configuration
      description: Use this method to create an account recording configuration. <a href="https://www.infobip.com/docs/conversations/calls#recording-set-up-calls" target="_blank">More info</a>.
      operationId: create-conversations-account-recording-config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    inbound: true
                    outbound: true
                    autoCompose: false
                    mediaType: AUDIO_AND_VIDEO
                    videoDownloadPreparation: false
                    enabled: true
                    enabledChangedAt: 1622024333000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Missing Media Type:
                  summary: Missing Media Type
                  description: Missing Media Type
                  value:
                    status: ERROR
                    message: 'mediaType: Missing Media Type'
                Account recording config already exists:
                  summary: Account recording config already exists
                  description: Account recording config already exists
                  value:
                    status: ERROR
                    message: Account recording config already exists!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/agent-recording-configs:
    get:
      tags:
      - customer-engagement
      summary: Get agent recording configurations
      description: Use this method to retrieve agent recording configurations. <a href="https://www.infobip.com/docs/conversations/calls#recording-set-up-calls" target="_blank">More info</a>.
      operationId: get-conversations-agent-recording-configs
      parameters:
      - name: agentIds
        in: query
        description: Agent ids of agent recording configs to get.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                  - agentId: 06869037EBD6756A98B7C621D0869DA7
                    inbound: true
                    outbound: true
                    mediaType: AUDIO_AND_VIDEO
                    useDefault: true
                    enabled: true
                    enabledChangedAt: 21622024333000
                  - agentId: 05261D01CC88F5A8C0C7C3A1EF74E430
                    inbound: true
                    outbound: false
                    mediaType: AUDIO
                    useDefault: true
                    enabled: false
                    enabledChangedAt: 1622025585000
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/agent-recording-configs/{agentId}:
    get:
      tags:
      - customer-engagement
      summary: Get agent recording configuration
      description: Use this method to retrieve the agent recording configuration. <a href="https://www.infobip.com/docs/conversations/calls#recording-set-up-calls" target="_blank">More info</a>.
      operationId: get-conversations-agent-recording-config
      parameters:
      - name: agentId
        in: path
        description: Agent id of agent recording config to get.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    agentId: 05261D01CC88F5A8C0C7C3A1EF74E430
                    inbound: true
                    outbound: true
                    mediaType: AUDIO_AND_VIDEO
                    useDefault: true
                    enabled: false
                    enabledChangedAt: 1622024333000
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Agent not found:
                  summary: Agent not found
                  description: Agent not found
                  value:
                    status: ERROR
                    message: No agent found with id=E5FB76C90DD4203DF04364004843BAFB
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    put:
      tags:
      - customer-engagement
      summary: Update agent recording configuration
      description: Use this method to create or update an agent recording configuration. <a href="https://www.infobip.com/docs/conversations/calls#recording-set-up-calls" target="_blank">More info</a>.
      operationId: update-conversations-agent-recording-config
      parameters:
      - name: agentId
        in: path
        description: Agent id of agent recording config to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    inbound: true
                    outbound: true
                    autoCompose: false
                    mediaType: AUDIO_AND_VIDEO
                    videoDownloadPreparation: false
                    enabled: true
                    enabledChangedAt: 1622024333000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Either outbound or inbound should be selected:
                  summary: Either outbound or inbound should be selected
                  description: Either outbound or inbound should be selected
                  value:
                    status: ERROR
                    message: 'mediaType: Missing Media Type; inbound: Either inbound or outbound should be selected'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Agent not found:
                  summary: Agent not found
                  description: Agent not found
                  value:
                    status: ERROR
                    message: No agent found with id=E5FB76C90DD4203DF04364004843BAFB
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    post:
      tags:
      - customer-engagement
      summary: Create agent recording configuration
      description: Use this method to create an agent recording configuration. <a href="https://www.infobip.com/docs/conversations/calls#recording-set-up-calls" target="_blank">More info</a>.
      operationId: create-conversations-agent-recording-config
      parameters:
      - name: agentId
        in: path
        description: Agent id of agent recording config to create.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    inbound: true
                    outbound: true
                    autoCompose: false
                    mediaType: AUDIO_AND_VIDEO
                    videoDownloadPreparation: false
                    enabled: true
                    enabledChangedAt: 1622024333000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Either outbound or inbound should be selected:
                  summary: Either outbound or inbound should be selected
                  description: Either outbound or inbound should be selected
                  value:
                    status: ERROR
                    message: 'mediaType: Missing Media Type; inbound: Either inbound or outbound should be selected'
                Agent recording config already exists:
                  summary: Agent recording config already exists
                  description: Agent recording config already exists
                  value:
                    status: ERROR
                    message: Agent recording config already exists!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Agent not found:
                  summary: Agent not found
                  description: Agent not found
                  value:
                    status: ERROR
                    message: No agent found with id=E5FB76C90DD4203DF04364004843BAFB
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/recording/metadata:
    get:
      tags:
      - customer-engagement
      summary: Get recording metadata
      description: Use this method to retrieve a pageable list of recording metadata based on parameters.
      operationId: get-conversations-recording-metadata
      parameters:
      - name: recordingId
        in: query
        description: Unique id of the recorded file.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: conversationId
        in: query
        description: Unique id of the conversation.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: conferenceId
        in: query
        description: Unique id of the conference.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: callId
        in: query
        description: Unique id of the call.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: direction
        in: query
        description: Call direction of recorded file.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: filename
        in: query
        description: Filename of recorded file.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: participantId
        in: query
        description: Participant id associated with the recorded file.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: participantIdentity
        in: query
        description: Participant identity associated with the recorded file.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: participantName
        in: query
        description: Participant name associated with the recorded file.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: participantType
        in: query
        description: Participant type associated with the recorded file.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: mediaType
        in: query
        description: Media type of recorded file.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: deletedBy
        in: query
        description: Identity of the user who deleted the recorded file.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: transferredFrom
        in: query
        description: Identity of the user who has transferred the call.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: transferredTo
        in: query
        description: Identity of the user to whom the call has been transferred.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: transferredFromQueue
        in: query
        description: Queue id from which the call has been transferred.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: transferredToQueue
        in: query
        description: Queue id to which the call has been transferred.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: durationFrom
        in: query
        description: Minimum duration to filter recorded files.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: durationTo
        in: query
        description: Maximum duration to filter recorded files.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: startedAtFrom
        in: query
        description: Lower bound for filtering by recording start time.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: startedAtTo
        in: query
        description: Upper bound for filtering by recording start time.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: deletedAtFrom
        in: query
        description: Lower bound for filtering by deleted at time.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: deletedAtTo
        in: query
        description: Upper bound for filtering by deleted at time.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: page
        in: query
        description: Page number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Page size.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 999
          minimum: 1
      - name: sortBy
        in: query
        description: Field by which the sorting will be done.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sortDirection
        in: query
        description: Type of sorting.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Direction'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.RecordingMetadataApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    elements:
                    - id: 1
                      recordingId: 11f1b111-1111-1111-a111-1111e11f111e
                      conversationId: 11f1b111-1111-1111-a111-1111e11f111a
                      conferenceId: 11f1b111-1111-1111-a111-1111e11f111b
                      callId: 11f1b111-1111-1111-a111-1111e11f111c
                      direction: INBOUND
                      recordingStatus: SUCCESSFUL
                      composed: false
                      filename: 11f1b111-1111-1111-a111-1111e11f111a_IDENTITY_20230612155341-11f1b111-1111-1111-a111-1111e11f111e.wav
                      duration: 28
                      participantId: 11f1b111-1111-1111-a111-1111e11f111d
                      participantIdentity: customer1
                      participantName: Customer 1
                      participantType: CUSTOMER
                      mediaType: AUDIO
                      startedAt: 1686585221999
                      deletedAt: null
                      deletedBy: null
                      sftpPath: null
                      transferredFrom: null
                      transferredTo: null
                      transferredFromQueue: null
                      transferredToQueue: null
                    - id: 2
                      recordingId: 52341263-0a22-1111-a1a1-1111bade8581
                      conversationId: 52341263-0a22-1111-a1a1-1111bade8582
                      conferenceId: 52341263-0a22-1111-a1a1-1111bade8583
                      callId: 52341263-0a22-1111-a1a1-1111bade8584
                      direction: INBOUND
                      recordingStatus: SUCCESSFUL
                      composed: false
                      filename: 52341263-0a22-1111-a1a1-1111bade8582_IDENTITY_20230612155341-52341263-0a22-1111-a1a1-1111bade8581.wav
                      duration: 28
                      participantId: 52341263-0a22-1111-a1a1-1111bade8584
                      participantIdentity: agent1
                      participantName: Agent 1
                      participantType: AGENT
                      mediaType: AUDIO
                      startedAt: 1686585221999
                      deletedAt: null
                      deletedBy: null
                      sftpPath: null
                      transferredFrom: null
                      transferredTo: null
                      transferredFromQueue: null
                      transferredToQueue: null
                    total: 2
                    totalPages: 1
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Size must be greater or equal to 1:
                  summary: Size must be greater or equal to 1
                  description: Size must be greater or equal to 1
                  value:
                    status: ERROR
                    message: 'size: must be greater than or equal to 1'
                Page must be greater or equal to 0:
                  summary: Page must be greater or equal to 0
                  description: Page must be greater or equal to 0
                  value:
                    status: ERROR
                    message: 'page: must be greater than or equal to 0'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/recording/download/{recordingId}:
    get:
      tags:
      - customer-engagement
      summary: Download call recording
      description: Use this endpoint to download a call recording using recordingId.
      operationId: download-call-recording
      parameters:
      - name: recordingId
        in: path
        description: Id of the recording to download.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: Range
        in: header
        description: Range header specifies range of bytes to be returned by the response. If range header is not specified, response will return a complete file.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StreamingResponseBody'
        '206':
          description: Partial Content
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StreamingResponseBody'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: ERROR
                    message: Invalid range header format
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not Found:
                  summary: Not Found
                  description: Not Found
                  value:
                    status: ERROR
                    message: Recording file abcdefgh-1234-5678-9012-abcdefgh not found!
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 100
        requestedTokens: 1
        burstCapacity: 100
  /ccaas/voice/2/account-wrap-up-config:
    get:
      tags:
      - customer-engagement
      summary: Get account wrap up configuration
      description: Use this method to retrieve the current account wrap up configuration. Wrap up is the time after a call during which an agent's status is still BUSY. Default wrap up time is 30 seconds. <a href="https://www.infobip.com/docs/conversations/calls#wrap-up-window-agent-guide" target="_blank">More info</a>.
      operationId: get-conversations-account-wrap-up-config
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountWrapUpApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    wrapUpSeconds: 30
                    canExtendWrapUp: true
                    enabled: true
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    put:
      tags:
      - customer-engagement
      summary: Update account wrap up configuration
      description: Use this method to update account wrap up configuration. Wrap up is the time after a call during which an agent's status is still BUSY. Default wrap up time is 30 seconds. <a href="https://www.infobip.com/docs/conversations/calls#wrap-up-window-agent-guide" target="_blank">More info</a>.
      operationId: update-conversations-account-wrap-up-config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountWrapUpApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountWrapUpApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    wrapUpSeconds: 30
                    canExtendWrapUp: true
                    enabled: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Missing parameters:
                  summary: Missing parameters
                  description: Missing parameters
                  value:
                    status: ERROR
                    message: 'wrapUpSeconds: Missing wrapup duration.'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccca/1/agent-configs/{agentId}/wrap-up:
    put:
      tags:
      - customer-engagement
      summary: Update agent wrap up configuration
      description: Use this method to create or update agent wrap up configuration.
      operationId: update-conversations-agent-wrap-up-config
      parameters:
      - name: agentId
        in: path
        description: Agent ID used to update the configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: wrapUpSeconds
        in: query
        description: Wrap up duration in seconds for agent. Setting null will default to account wrap up duration. Send this parameter in request body instead.<a href="https://www.infobip.com/docs/conversations/calls#wrap-up-window-agent-guide" target="_blank">More info</a>.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          minimum: 0
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigWrapUpApiModel'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    wrapUpSeconds: 30
                    backgroundBlurSettings:
                      mode: VIRTUAL_BACKGROUND
                      fileMetadata:
                        fileId: 91184DE7-92BF-4F94-875C-8E701AE71DF9
                        fileName: background.jpg
                        fileSize: 3605569
                        fileUrl: https://file.cloudfront.net/client-contact-center-background-images/someImageUrl
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    status: ERROR
                    message: 'agentConfig.wrapUpSeconds: must be greater than or equal to 0'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/agent/{agentId}/wrap-up-time/add/{seconds}:
    patch:
      tags:
      - customer-engagement
      summary: Add agent wrap up time
      description: Use this method to extend the agent wrap up time after a call, by specified number of seconds. Number of seconds should be a positive number. Agent should be in Wrapping status. Wrap up is the time after a call during which an agent's status is still BUSY. <a href="https://www.infobip.com/docs/conversations/calls#wrap-up-window-agent-guide" target="_blank">More info</a>.
      operationId: add-conversations-agent-wrap-up-time
      parameters:
      - name: agentId
        in: path
        description: Agent id of agent wrap up to add.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: seconds
        in: path
        description: Number of seconds to extend wrap up time.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: SUCCESS
                    message: Agent wrap up time added successfully.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Invalid seconds number:
                  summary: Invalid seconds number
                  description: Invalid seconds number
                  value:
                    status: ERROR
                    message: Number of seconds should be greater then 0.
                Agent not in Wrapping status:
                  summary: Agent not in Wrapping status
                  description: Agent not in Wrapping status
                  value:
                    status: ERROR
                    message: Agent is not in Wrapping status.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/voice/2/agent/{agentId}/wrap-up-time/clear:
    patch:
      tags:
      - customer-engagement
      summary: Clear agent wrap up time
      description: Use this method to clear the agent wrap up time after a call. After that, the agent will no longer have Wrapping status. Wrap up is the time after a call during which an agent's status is still BUSY. <a href="https://www.infobip.com/docs/conversations/calls#wrap-up-window-agent-guide" target="_blank">More info</a>.
      operationId: clear-conversations-agent-wrap-up-time
      parameters:
      - name: agentId
        in: path
        description: Agent id of agent wrap up to clear.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: SUCCESS
                    message: Agent wrap up time cleared successfully.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/voice/2/conversation/{conversationId}/transfer/agent:
    patch:
      tags:
      - customer-engagement
      summary: Transfer call to another agent
      description: Use this method to transfer a call to another agent. Please note that the targeted agent must be available for the transfer to succeed. The conversation will be assigned to the targeted agent once they answer the call. <a href="https://www.infobip.com/docs/conversations/calls#transfer-to-agent-agent-guide" target="_blank">More info</a>.
      operationId: transfer-call-to-agent
      parameters:
      - name: conversationId
        in: path
        description: Conversation ID whose call is being transferred.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 82f57414-b989-4856-ac9f-32a54e9ee86b
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToAgentRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: SUCCESS
                    message: Call transferred successfully.
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: NOT FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Agent is not found:
                  summary: Agent is not found
                  description: Agent is not found
                  value:
                    status: ERROR
                    message: Destination for given transfer is not found.
        '409':
          description: NOT AVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Agent is not available:
                  summary: Agent is not available
                  description: Agent is not available
                  value:
                    status: ERROR
                    message: Given destination for transfer is currently not available.
        '412':
          description: PRECONDITION FAILED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Conference is missing for given conversationId:
                  summary: Conference is missing for given conversationId
                  description: Conference is missing for given conversationId
                  value:
                    status: ERROR
                    message: Conference is missing for given conversationId.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/voice/2/transfer/queues:
    get:
      tags:
      - customer-engagement
      summary: Fetch queues eligible as transfer destination
      description: This method retrieves a list of all queues and returns them along with their current activity status. The activity status indicates whether or not a queue is currently inside of working hours. The list of queues and their activity can be used to determine which queues are currently able to receive incoming transfer requests. <a href="https://www.infobip.com/docs/conversations/calls#transfer-to-queue-agent-guide" target="_blank">More info</a>.
      operationId: get-transfer-queues
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 2000
          minimum: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.PageResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    elements:
                    - queueId: FD213C73E81B6AFG241AA3462128BD2A
                      queueName: Queue1
                      active: true
                      autoAssignmentEnabled: true
                    - queueId: MAC923F1G7D439CF6F0A2K2L6EA6134
                      queueName: Queue2
                      active: false
                      autoAssignmentEnabled: true
                    - queueId: null
                      queueName: Default Queue
                      active: false
                      autoAssignmentEnabled: true
                    total: 3
                    totalPages: 1
        '400':
          description: BAD REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Size must be greater or equal to 1:
                  summary: Size must be greater or equal to 1
                  description: Size must be greater or equal to 1
                  value:
                    status: ERROR
                    message: 'size: must be greater than or equal to 1'
                Page must be greater or equal to 0:
                  summary: Page must be greater or equal to 0
                  description: Page must be greater or equal to 0
                  value:
                    status: ERROR
                    message: 'page: must be greater than or equal to 0'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 100
  /ccaas/voice/2/conversation/{conversationId}/transfer/queue:
    patch:
      tags:
      - customer-engagement
      summary: Transfer call to another queue
      description: Use this method to transfer a call to another queue. Please note that the targeted queue must be within working hours and have auto-assignment enabled for the transfer to succeed. The agent selection process will be run, and the conversation will be assigned to the agent who answers the call. <a href="https://www.infobip.com/docs/conversations/calls#transfer-to-queue-agent-guide" target="_blank">More info</a>.
      operationId: transfer-call-to-queue
      parameters:
      - name: conversationId
        in: path
        description: Conversation ID whose call is being transferred.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 82f57414-b989-4856-ac9f-32a54e9ee86b
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToQueueRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: SUCCESS
                    message: Call transferred successfully.
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: NOT FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Queue is not found:
                  summary: Queue is not found
                  description: Queue is not found
                  value:
                    status: ERROR
                    message: Destination for given transfer is not found.
        '409':
          description: NOT AVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Queue is not available:
                  summary: Queue is not available
                  description: Queue is not available
                  value:
                    status: ERROR
                    message: Given destination for transfer is currently not available.
        '412':
          description: PRECONDITION FAILED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Conference is missing for given conversationId:
                  summary: Conference is missing for given conversationId
                  description: Conference is missing for given conversationId
                  value:
                    status: ERROR
                    message: Conference is missing for given conversationId.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/voice/2/conversation/{conversationId}/transfer/external-number:
    patch:
      tags:
      - customer-engagement
      summary: Transfer call to external number
      description: Use this method to transfer the call to an external phone number. Depending on the Transfer to External Number configuration, the Agent can transfer the call to any valid phone number or only to the numbers in the People with the external_number tag. <a href="https://www.infobip.com/docs/conversations/calls#transfer-to-external-number-agent-guide" target="_blank">More info</a>.
      operationId: transfer-call-to-external-number
      parameters:
      - name: conversationId
        in: path
        description: Conversation ID whose call is being transferred.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 82f57414-b989-4856-ac9f-32a54e9ee86b
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: SUCCESS
                    message: Call transferred successfully.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/30bce31dfbdcb9fa9268f4e4ce1f7ccf05ef063a92c880be9d1b9efcfc2ac71a.ApiException'
              examples:
                Bad Request:
                  summary: Bad Request
                  description: Bad Request
                  value:
                    status: ERROR
                    message: Empty or invalid request payload
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '409':
          description: Not Available
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                External number is not available:
                  summary: External number is not available
                  description: External number is not available
                  value:
                    status: ERROR
                    message: Given destination for transfer is currently not available.
        '412':
          description: Precondition Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Conference is missing for given conversationId:
                  summary: Conference is missing for given conversationId
                  description: Conference is missing for given conversationId
                  value:
                    status: ERROR
                    message: Conference is missing for given conversationId.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/voice/2/transfer-configs/external-number:
    get:
      tags:
      - customer-engagement
      summary: Get transfer to external number configuration
      description: Use this endpoint to get a Transfer to external number configuration. <a href="https://www.infobip.com/docs/conversations/calls#transfer-to-external-number-set-up-calls" target="_blank">More info</a>.
      operationId: get-transfer-to-external-number-config
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    tagName: external_number
                    transferToAnyNumberEnabled: true
                    createdAt: '2022-11-18T09:23:44.033Z'
                    updatedAt: '2023-01-24T21:44:31.630Z'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not Found:
                  summary: Not Found
                  description: Not Found
                  value:
                    status: ERROR
                    message: No transfer to external number config found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    put:
      tags:
      - customer-engagement
      summary: Update transfer to external number configuration
      description: Use this endpoint to update an already existing transfer to external number configuration. <a href="https://www.infobip.com/docs/conversations/calls#transfer-to-external-number-set-up-calls" target="_blank">More info</a>.
      operationId: update-transfer-to-external-number-config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalConfigApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalConfigApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    tagName: external_number
                    transferToAnyNumberEnabled: true
                    createdAt: '2022-11-18T09:23:44.033Z'
                    updatedAt: '2023-01-24T21:44:31.630Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad Request:
                  summary: Bad Request
                  description: Bad Request
                  value:
                    status: ERROR
                    message: Empty or invalid request payload
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/transfer-configs/transfer-strategy:
    get:
      tags:
      - customer-engagement
      summary: Get transfer strategy
      description: Use this endpoint to get a Transfer Strategy. <a href="https://www.infobip.com/docs/conversations/calls#custom-transfer-music-and-message-set-up-calls" target="_blank">More info</a>.
      operationId: get-transfer-strategy
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferStrategyApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 642bf5f4ff5dd177aeb00889
                    musicOnHold:
                      enabled: true
                      useDefault: false
                      fileAudioSource:
                        fileDescriptor: f829e911-8439-4321-aa25-23b321e1a9cb
                    announcementMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: You're are being transferred...
                        language: en
                        voice:
                          name: Joanna
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                      repeatInterval:
                        unit: SECONDS
                        value: 5
                    createdAt: '2023-04-04T10:03:32.729Z'
                    updatedAt: '2023-04-06T11:22:18.149Z'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not Found:
                  summary: Not Found
                  description: Not Found
                  value:
                    status: ERROR
                    message: No transfer strategy found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    put:
      tags:
      - customer-engagement
      summary: Update transfer strategy
      description: Use this endpoint to update an already existing Transfer Strategy. <a href="https://www.infobip.com/docs/conversations/calls#custom-transfer-music-and-message-set-up-calls" target="_blank">More info</a>.
      operationId: update-transfer-strategy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferStrategyApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferStrategyApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 642bf5f4ff5dd177aeb00889
                    musicOnHold:
                      enabled: true
                      useDefault: false
                      fileAudioSource:
                        fileDescriptor: f829e911-8439-4321-aa25-23b321e1a9cb
                    announcementMessage:
                      enabled: true
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: You're are being transferred...
                        language: en
                        voice:
                          name: Joanna
                          gender: FEMALE
                        speechRate: 1.0
                      fileAudioSource: null
                      repeatInterval:
                        unit: SECONDS
                        value: 5
                    createdAt: '2023-04-04T10:03:32.729Z'
                    updatedAt: '2023-04-06T11:22:18.149Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad Request:
                  summary: Bad Request
                  description: Bad Request
                  value:
                    status: ERROR
                    message: Empty or invalid request payload
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/{conversationId}/hold:
    patch:
      tags:
      - customer-engagement
      summary: Put client on hold
      description: Use this method to put your client on hold. <a href="https://www.infobip.com/docs/conversations/calls#call-on-hold-agent-guide" target="_blank">More info</a>.
      operationId: set-call-on-hold
      parameters:
      - name: conversationId
        in: path
        description: Conversation id of the conversation which you want to put on hold.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: SUCCESS
                    message: Hold action successful.
        '400':
          description: BAD REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: ERROR
                    message: Hold action failed.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: NOT FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not Found:
                  summary: Not Found
                  description: Not Found
                  value:
                    status: ERROR
                    message: Not Found.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/voice/2/{conversationId}/unhold:
    patch:
      tags:
      - customer-engagement
      summary: Put client off hold
      description: Use this method to release your client from hold. <a href="https://www.infobip.com/docs/conversations/calls#call-on-hold-agent-guide" target="_blank">More info</a>.
      operationId: release-call-from-hold
      parameters:
      - name: conversationId
        in: path
        description: Conversation id of the conversation which you want to put off hold.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value: "{\n    \"status\": \"SUCCESS\"\n    \"message\": \"Unhold action successful.\"\n}\n"
        '400':
          description: BAD REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: ERROR
                    message: Unhold action failed.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: NOT FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not Found:
                  summary: Not Found
                  description: Not Found
                  value:
                    status: ERROR
                    message: Not Found.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/voice/2/hold-configs-per-queue:
    get:
      tags:
      - customer-engagement
      summary: Get hold configurations
      description: Use this endpoint to retrieve multiple hold configurations based on the page number and page size parameters. <a href="https://www.infobip.com/docs/conversations/calls#call-on-hold-set-up-calls" target="_blank">More info</a>.
      operationId: get-multiple-hold-configs
      parameters:
      - name: pageNumber
        in: query
        description: Number of the page to show.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Size of a single page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: sortDirection
        in: query
        description: Type of sorting (ASC or DESC).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sortBy
        in: query
        description: Field by which the sorting will be done.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel'
              examples:
                Successful Response:
                  summary: Successful Response
                  description: Successful Response
                  value:
                    elements:
                    - id: 63a99eb0b8863d4d26678000
                      name: Hold Config Name1
                      onHoldMusic:
                        enabled: true
                        useDefault: false
                        fileAudioSource:
                          fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1124
                      announcementMessage:
                        audioSourceType: TTS
                        ttsAudioSource:
                          text: Hello this a text to speech message
                          language: English
                          voice:
                            name: Name1
                            gender: FEMALE
                          speechRate: 1.0
                          fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1125
                        fileAudioSource:
                          fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb116
                        duration:
                          unit: MINUTES
                          value: 2
                      default: false
                      enabled: true
                      queueIds:
                      - FD80A6AA8E0DB8A5165276570943D8CF
                      - A4BBE5D92667EEAB69860D457E877A59
                      createdAt: '2022-12-10T13:45:00.000Z'
                      updatedAt: '2022-12-10T13:45:00.000Z'
                    - id: 63a99eb0b8863d4d26678001
                      name: Hold Config Name2
                      createdAt: '2022-12-12T13:45:00.000Z'
                      updatedAt: '2022-12-12T13:45:00.000Z'
                      onHoldMusic:
                        enabled: true
                        useDefault: false
                        fileAudioSource:
                          fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1135
                      announcementMessage:
                        audioSourceType: TTS
                        ttsAudioSource:
                          text: Hello this a text to speech message
                          language: Spanish
                          voice:
                            name: Name2
                            gender: Male
                          speechRate: 1.0
                          fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1132
                        fileAudioSource:
                          fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb136
                        duration:
                          unit: MINUTES
                          value: 4
                      default: false
                      enabled: true
                      queueIds:
                      - FD80A6AA8E0DB8A5165276570943D8CF
                      - A4BBE5D92667EEAB69860D457E877A59
                    total: 8
                    totalPages: 10
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad Request:
                  summary: Bad Request
                  description: Bad Request
                  value:
                    status: ERROR
                    message: Hold configuration must be applied to at least one queue.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    post:
      tags:
      - customer-engagement
      summary: Create hold configuration
      description: Use this endpoint to create a new hold configuration, together with queues it is applied to. <a href="https://www.infobip.com/docs/conversations/calls#call-on-hold-set-up-calls" target="_blank">More info</a>.
      operationId: create-hold-config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 63a99eb0b8863d4d26678000
                    name: Hold Config Name
                    onHoldMusic:
                      enabled: true
                      useDefault: false
                      fileAudioSource:
                        fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1124
                    announcementMessage:
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Hello this a text to speech message
                        language: English
                        voice:
                          name: Test
                          gender: FEMALE
                        speechRate: 1.0
                        fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1125
                      fileAudioSource:
                        fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb116
                      duration:
                        unit:
                        - SECONDS
                        - MINUTES
                        - HOURS
                        value: 2
                    default: false
                    enabled: true
                    queueIds:
                    - FD80A6AA8E0DB8A5165276570943D8CF
                    - A4BBE5D92667EEAB69860D457E877A59
                    createdAt: 2022-12-10T13:45:00.777+0000
                    updatedAt: 2022-12-10T13:45:00.777+0000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad Request:
                  summary: Bad Request
                  description: Bad Request
                  value:
                    status: ERROR
                    message: Hold configuration must be applied to at least one queue.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not Found:
                  summary: Not Found
                  description: Not Found
                  value:
                    status: ERROR
                    message: 'No hold config found with id: 123'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/hold-configs-per-queue/{id}:
    get:
      tags:
      - customer-engagement
      summary: Get hold configuration
      description: Use this endpoint to get a single hold configuration by its id. <a href="https://www.infobip.com/docs/conversations/calls#call-on-hold-set-up-calls" target="_blank">More info</a>.
      operationId: get-hold-config
      parameters:
      - name: id
        in: path
        description: Id of the Hold Configuration to get.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel'
              examples:
                Successful Response:
                  summary: Successful Response
                  description: Successful Response
                  value:
                    id: 63a99eb0b8863d4d26678000
                    name: Hold Config Name
                    onHoldMusic:
                      enabled: true
                      useDefault: false
                      fileAudioSource:
                        fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1124
                    announcementMessage:
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Hello this a text to speech message
                        language: English
                        voice:
                          name: Test
                          gender: FEMALE
                        speechRate: 1.0
                        fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1125
                      fileAudioSource:
                        fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb116
                      duration:
                        unit:
                        - SECONDS
                        - MINUTES
                        - HOURS
                        value: 2
                    default: false
                    enabled: true
                    queueIds:
                    - FD80A6AA8E0DB8A5165276570943D8CF
                    - A4BBE5D92667EEAB69860D457E877A59
                    createdAt: 2022-12-10T13:45:00.777+0000
                    updatedAt: 2022-12-10T13:45:00.777+0000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad Request:
                  summary: Bad Request
                  description: Bad Request
                  value:
                    status: ERROR
                    message: Hold configuration must be applied to at least one queue.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not Found:
                  summary: Not Found
                  description: Not Found
                  value:
                    status: ERROR
                    message: 'No hold config found with id: 123'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    put:
      tags:
      - customer-engagement
      summary: Update hold configuration
      description: Use this endpoint to update an already existing hold configuration. <a href="https://www.infobip.com/docs/conversations/calls#call-on-hold-set-up-calls" target="_blank">More info</a>.
      operationId: update-hold-config
      parameters:
      - name: id
        in: path
        description: Id of the Hold Configuration being updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 63a99eb0b8863d4d26678000
                    name: Hold Config Name
                    onHoldMusic:
                      enabled: true
                      useDefault: false
                      fileAudioSource:
                        fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1124
                    announcementMessage:
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Hello this a text to speech message
                        language: English
                        voice:
                          name: Test
                          gender: FEMALE
                        speechRate: 1.0
                        fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1125
                      fileAudioSource:
                        fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb116
                      duration:
                        unit:
                        - SECONDS
                        - MINUTES
                        - HOURS
                        value: 2
                    default: false
                    enabled: true
                    queueIds:
                    - FD80A6AA8E0DB8A5165276570943D8CF
                    - A4BBE5D92667EEAB69860D457E877A59
                    createdAt: 2022-12-10T13:45:00.777+0000
                    updatedAt: 2022-12-10T13:45:00.777+0000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad Request:
                  summary: Bad Request
                  description: Bad Request
                  value:
                    status: ERROR
                    message: Hold configuration must be applied to at least one queue.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not Found:
                  summary: Not Found
                  description: Not Found
                  value:
                    status: ERROR
                    message: 'No hold config found with id: 123'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    delete:
      tags:
      - customer-engagement
      summary: Delete hold configuration
      description: Use this endpoint to delete a single, already existing hold configuration by its id. <a href="https://www.infobip.com/docs/conversations/calls#call-on-hold-set-up-calls" target="_blank">More info</a>.
      operationId: delete-hold-config
      parameters:
      - name: id
        in: path
        description: Id of the Hold Configuration to be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful Response:
                  summary: Successful Response
                  description: Successful Response
                  value:
                    status: SUCCESS
                    message: Hold Configuration deleted.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad Request:
                  summary: Bad Request
                  description: Bad Request
                  value:
                    status: ERROR
                    message: Hold configuration must be applied to at least one queue.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not Found:
                  summary: Not Found
                  description: Not Found
                  value:
                    status: ERROR
                    message: 'No hold config found with id: 123'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/voice/2/call-timeouts:
    get:
      tags:
      - customer-engagement
      summary: Get call timeout
      description: Use this method to retrieve call timeout configuration.
      operationId: get-conversations-call-timeout
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CallTimeoutApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    inbound: 30
                    outbound: 45
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    put:
      tags:
      - customer-engagement
      summary: Update call timeout
      description: Use this method to update call timeout configuration. Null field will resolve to default value.
      operationId: update-conversations-call-timeout
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CallTimeoutApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CallTimeoutApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    inbound: 30
                    outbound: 45
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    delete:
      tags:
      - customer-engagement
      summary: Remove custom call timeout
      description: Use this method to remove the custom inbound call timeout configuration.
      operationId: remove-conversations-call-timeout
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: DELETED
                    message: Inbound Call Timeout removed successfully.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-deprecationInformation:
        deprecation: 2025-03-06T12:00:00.000+0000
        sunset: 2025-09-06T12:00:00.000+0000
        successorOperationId: update-conversations-call-timeout
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/1/working-hours:
    get:
      tags:
      - customer-engagement
      summary: Get filtered working hours
      description: 'Use this method to get a list of working hours with pagination and filtering options. Using filter is optional.

        The result can be filtered by one or many optional filters described in the parameters.'
      operationId: get-filtered-working-hours
      parameters:
      - name: name
        in: query
        description: Optional. Working hours that contain a name case-insensitive.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: enabled
        in: query
        description: Optional. Working hours enable/disable toggle.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: isDefault
        in: query
        description: Optional. Default working hours.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: createdAfter
        in: query
        description: 'Optional. Filter results created after specific date and time.

          Format: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdBefore
        in: query
        description: 'Optional. Filter results created before specific date and time.

          Format: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedAfter
        in: query
        description: 'Optional. Filter results updated after specific date and time.

          Format: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedBefore
        in: query
        description: 'Optional. Filter results updated before specific date and time.

          Format: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        description: Size of the result page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 10
          maximum: 999
      - name: page
        in: query
        description: Number of the current page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: orderBy
        in: query
        description: 'This parameter is used to order your results.

          If an order is not given, the default order id:asc will be applied.

          Possible ordering fields are properties.

          Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursResultPageApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    workingHours:
                    - id: 07ad4193-4354-488c-b45f-293dfa4c90fb
                      timezone: Etc/UTC
                      message: We're out of office, come back another time, thank you!
                      name: My UTC Working Hours
                      enabled: true
                      isDefault: true
                      closeConversations: false
                    - id: b0292453-3d2f-4242-8667-1c769d8a2cc9
                      timezone: America/New_York
                      message: We're out of office, come back another time, thank you!
                      name: My USA Working Hours
                      enabled: true
                      isDefault: false
                      closeConversations: true
                    pagination:
                      totalItems: 0
                      page: 0
                      limit: 0
                      orderBy: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid page size:
                  summary: Invalid page size
                  description: Invalid page size
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Page size has to be bigger or equal to zero!
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    post:
      tags:
      - customer-engagement
      summary: Create working hours
      description: 'Use this method to create new working hours.

        An auto-reply message will be sent to the customer when working hours are set and enabled and a new conversation is created outside of working hours,

        or a holiday is set for the enabled working hours and a new conversation is created during the holiday.'
      operationId: create-working-hours
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 07ad4193-4354-488c-b45f-293dfa4c90fb
                    timezone: Etc/UTC
                    message: We're out of office, come back another time, thank you!
                    workWeek:
                      MONDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      TUESDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      WEDNESDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      THURSDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      FRIDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      SATURDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      SUNDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                    name: My Working Hours
                    enabled: true
                    isDefault: true
                    closeConversations: false
                    holidays: []
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/working-hours/{id}:
    get:
      tags:
      - customer-engagement
      summary: Get working hours
      description: Use this method to get single working hours.
      operationId: get-working-hours
      parameters:
      - name: id
        in: path
        description: Working hours Id to get.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 07ad4193-4354-488c-b45f-293dfa4c90fb
                    timezone: Etc/UTC
                    message: We're out of office, come back another time, thank you!
                    workWeek:
                      MONDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      TUESDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      WEDNESDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      THURSDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      FRIDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      SATURDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      SUNDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                    name: My Working Hours
                    enabled: true
                    isDefault: true
                    closeConversations: false
                    holidays:
                    - id: aae9b06f-a323-4c9c-b807-7a9e4e015405
                      workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
                      name: New Year's Day
                      startDate: '2021-01-01'
                      endDate: '2021-01-01'
                      enabled: true
                    - id: 6bfb9b10-caec-4f53-85a9-b87da6afa88f
                      workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
                      name: My Holiday
                      startDate: '2021-06-09'
                      endDate: '2021-06-09'
                      enabled: false
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Update working hours
      description: Use this method to update working hours.
      operationId: update-working-hours
      parameters:
      - name: id
        in: path
        description: Working hours Id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 07ad4193-4354-488c-b45f-293dfa4c90fb
                    timezone: Etc/UTC
                    message: We're out of office, come back another time, thank you!
                    workWeek:
                      MONDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      TUESDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      WEDNESDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      THURSDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      FRIDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      SATURDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      SUNDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                    name: My Working Hours
                    enabled: true
                    isDefault: true
                    closeConversations: false
                    holidays:
                    - id: aae9b06f-a323-4c9c-b807-7a9e4e015405
                      workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
                      name: New Year's Day
                      startDate: '2021-01-01'
                      endDate: '2021-01-01'
                      enabled: true
                    - id: 6bfb9b10-caec-4f53-85a9-b87da6afa88f
                      workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
                      name: My Holiday
                      startDate: '2021-06-09'
                      endDate: '2021-06-09'
                      enabled: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    delete:
      tags:
      - customer-engagement
      summary: Delete working hours
      description: Use this method to delete working hours.
      operationId: delete-working-hours
      parameters:
      - name: id
        in: path
        description: Working hours id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Working hours has been deleted.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    patch:
      tags:
      - customer-engagement
      summary: Patch working hours
      description: Use this method for working hours partial updating.
      operationId: patch-working-hours
      parameters:
      - name: id
        in: path
        description: Working hours Id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 07ad4193-4354-488c-b45f-293dfa4c90fb
                    timezone: Etc/UTC
                    message: We're out of office, come back another time, thank you!
                    workWeek:
                      MONDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      TUESDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      WEDNESDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      THURSDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      FRIDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      SATURDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      SUNDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                    name: My Working Hours
                    enabled: true
                    isDefault: true
                    closeConversations: false
                    holidays:
                    - id: aae9b06f-a323-4c9c-b807-7a9e4e015405
                      workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
                      name: New Year's Day
                      startDate: '2021-01-01'
                      endDate: '2021-01-01'
                      enabled: true
                    - id: 6bfb9b10-caec-4f53-85a9-b87da6afa88f
                      workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
                      name: My Holiday
                      startDate: '2021-06-09'
                      endDate: '2021-06-09'
                      enabled: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/working-hours/{id}/status:
    get:
      tags:
      - customer-engagement
      summary: Get working hours status
      description: Use this method to get current status of working hours.
      operationId: get-working-hours-status
      parameters:
      - name: id
        in: path
        description: Working hours Id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursStatusApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: INSIDE_OF_WORKING_HOURS
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
  /ccaas/1/working-hours/{workingHoursId}/holiday:
    post:
      tags:
      - customer-engagement
      summary: Create working hours holiday
      description: 'Use this method to create a holiday on working hours.

        An auto-reply message will be sent to the customer when working hours are set and enabled and a new conversation is created outside of working hours,

        or a holiday is set for the enabled working hours and a new conversation is created during the holiday.

        This method will return a full working hours object with a created holiday in it.'
      operationId: create-working-hours-holiday
      parameters:
      - name: workingHoursId
        in: path
        description: Working hours id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.HolidaysApiModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 07ad4193-4354-488c-b45f-293dfa4c90fb
                    timezone: Etc/UTC
                    message: We're out of office, come back another time, thank you!
                    workWeek:
                      MONDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      TUESDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      WEDNESDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      THURSDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      FRIDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      SATURDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                      SUNDAY:
                        startTime: 0
                        endTime: 1440
                        enabled: true
                    name: My Working Hours
                    enabled: true
                    isDefault: true
                    closeConversations: false
                    holidays:
                    - id: aae9b06f-a323-4c9c-b807-7a9e4e015405
                      workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
                      name: New Year's Day
                      startDate: '2021-01-01'
                      endDate: '2021-01-01'
                      enabled: true
                    - id: 6bfb9b10-caec-4f53-85a9-b87da6afa88f
                      workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
                      name: My Holiday
                      startDate: '2021-06-09'
                      endDate: '2021-06-09'
                      enabled: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid Id:
                  summary: Invalid Id
                  description: Invalid Id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/working-hours/{workingHoursId}/holiday/{id}:
    delete:
      tags:
      - customer-engagement
      summary: Remove working hours holiday
      description: Use this method to remove a holiday from working hours.
      operationId: delete-working-hours-holiday
      parameters:
      - name: workingHoursId
        in: path
        description: Id of the working hours to delete holiday from.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: Holiday Id to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    statusCode: SUCCESS
                    message: Holiday has been deleted.
                Error response:
                  summary: Error response
                  description: Error response
                  value:
                    statusCode: ERROR
                    message: Invalid holidayId '195ac982-d98f-40e8-b9d3-6f11c04afe4a' given! No such entity exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse'
              examples:
                Invalid holidayId:
                  summary: Invalid holidayId
                  description: Invalid holidayId
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid holidayId '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/voice/2/tts/options/placeholders/{ttsPurpose}:
    get:
      tags:
      - customer-engagement
      summary: Get supported TTS placeholders for purpose
      description: Use this method to retrieve supported TTS placeholders for specified purpose.
      operationId: get-conversations-tts-supported-placeholders
      parameters:
      - name: ttsPurpose
        in: path
        description: Purpose for which placeholders will be used in text-to-speech.
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPurposeApiModel'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.GetPlaceholdersApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                  - type: POSITION_IN_QUEUE
                    sayAs: DEFAULT
                    placeholderValue: '{{QUEUE_POSITION_DEFAULT}}'
                    placeholderPaddingSize: 0
                    requiresSSML: false
                  - type: POSITION_IN_QUEUE
                    sayAs: ORDINAL
                    placeholderValue: '{{QUEUE_POSITION_ORDINAL}}'
                    placeholderPaddingSize: 40
                    requiresSSML: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Bad Request:
                  summary: Bad Request
                  description: Bad Request
                  value:
                    status: ERROR
                    message: Voice not found.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Not Found:
                  summary: Not Found
                  description: Not Found
                  value:
                    status: ERROR
                    message: Unsupported operation requested
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
  /ccaas/voice/2/away-audio-message/{workingHoursConfigId}:
    get:
      tags:
      - customer-engagement
      summary: Get away audio message
      description: Use this method to retrieve an away audio message by its working hours configuration id.
      operationId: get-conversations-away-audio-message
      parameters:
      - name: workingHoursConfigId
        in: path
        description: Id of the working hours configuration whose away audio message needs to be retrieved.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AwayAudioMessageApiModel'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: id
                    workingHoursConfigId: '123'
                    audioSource:
                      enabled: false
                      audioSourceType: TTS
                      ttsAudioSource:
                        text: Random message
                        language: en
                        voice:
                          name: Joanna
                          gender: female
                        speechRate: 1.1
                      fileAudioSource:
                        fileDescriptor: file-descriptor-id-example
                    collectables:
                    - code: '1'
                      action: CALLBACK
                      value: 62a73f05502423205b2630cc
                    collectDuration:
                      unit: SECONDS
                      value: 15
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Away audio message not found:
                  summary: Away audio message not found
                  description: Away audio message not found
                  value:
                    status: ERROR
                    message: 'No record was found for the given workingHoursConfigId: 971382982603232920C7EB5EFD7644689'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
    delete:
      tags:
      - customer-engagement
      summary: Delete away audio message
      description: Use this method to delete an away audio message by its working hours configuration id.
      operationId: delete-conversations-away-audio-message
      parameters:
      - name: workingHoursConfigId
        in: path
        description: Id of the working hours configuration whose away audio message needs to be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: DELETED
                    message: Away Audio Message deleted.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse'
              examples:
                Away audio message not found:
                  summary: Away audio message not found
                  description: Away audio message not found
                  value:
                    status: ERROR
                    message: 'No record was found for the given workingHoursConfigId: 971382982603232920C7EB5EFD7644689'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      x-throttling-info:
      - type: token
        replenishRate: 10
        requestedTokens: 1
        burstCapacity: 20
  /ccaas/1/web-forms/{id}/submissions:
    post:
      tags:
      - customer-engagement
      summary: Submit web form data
      description: Use this method to submit a new set of data of the given web form. This will create a new conversation with the channel specified in the web form.
      operationId: submit-webform
      parameters:
      - name: id
        in: path
        description: Id of the Web Form which will be used to create a conversation.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormSubmissionApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormPostResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    conversationId: b468c1ec-1997-4e90-add6-b36dfd2b80a3
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/web-forms/{id}:
    get:
      tags:
      - customer-engagement
      summary: Get web form
      description: Use this method to get an existing web form.
      operationId: get-webform
      parameters:
      - name: id
        in: path
        description: Web Form Id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 7646c2ff-916d-46f1-9c53-5273476ed505
                    name: Test WebForm
                    channel: EMAIL
                    destination: destination@email.test
                    url: /ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post
                    enabled: true
                    createdAt: '2023-12-01T00:00:00.000+00:00'
                    updatedAt: '2023-12-01T00:00:00.000+00:00'
                    tagIds:
                    - 2423d4c7-23da-422a-9f15-ca08006051ea
                    - 2664c7c3-f546-4073-a961-b94aed465ee8
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
      - conversations:read
    put:
      tags:
      - customer-engagement
      summary: Update web form
      description: Use this method to update an existing web form.
      operationId: update-webform
      parameters:
      - name: id
        in: path
        description: Web Form Id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 7646c2ff-916d-46f1-9c53-5273476ed505
                    name: Test WebForm
                    channel: EMAIL
                    destination: destination@email.test
                    url: /ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post
                    enabled: true
                    createdAt: '2023-12-01T00:00:00.000+00:00'
                    updatedAt: '2023-12-01T00:00:00.000+00:00'
                    tagIds:
                    - 2423d4c7-23da-422a-9f15-ca08006051ea
                    - 2664c7c3-f546-4073-a961-b94aed465ee8
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid body:
                  summary: Invalid body
                  description: Invalid body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    delete:
      tags:
      - customer-engagement
      summary: Delete web form
      description: Use this method to delete an existing web form.
      operationId: delete-webform
      parameters:
      - name: id
        in: path
        description: Web Form Id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
    patch:
      tags:
      - customer-engagement
      summary: Patch web form
      description: Use this method to patch an existing web form.
      operationId: patch-webform
      parameters:
      - name: id
        in: path
        description: Web Form Id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 7646c2ff-916d-46f1-9c53-5273476ed505
                    name: Test WebForm
                    channel: EMAIL
                    destination: destination@email.test
                    url: /ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post
                    enabled: true
                    createdAt: '2023-12-01T00:00:00.000+00:00'
                    updatedAt: '2023-12-01T00:00:00.000+00:00'
                    tagIds:
                    - 2423d4c7-23da-422a-9f15-ca08006051ea
                    - 2664c7c3-f546-4073-a961-b94aed465ee8
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid request body.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Invalid id:
                  summary: Invalid id
                  description: Invalid id
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /ccaas/1/web-forms:
    post:
      tags:
      - customer-engagement
      summary: Create web form
      description: Use this method to create a new web form.
      operationId: create-webform
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    id: 7646c2ff-916d-46f1-9c53-5273476ed505
                    name: Test WebForm
                    channel: EMAIL
                    destination: destination@email.test
                    url: /ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post
                    enabled: true
                    createdAt: '2023-12-01T00:00:00.000+00:00'
                    updatedAt: '2023-12-01T00:00:00.000+00:00'
                    tagIds:
                    - 2423d4c7-23da-422a-9f15-ca08006051ea
                    - 2664c7c3-f546-4073-a961-b94aed465ee8
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse'
              examples:
                Web Form name already exists:
                  summary: Web Form name already exists
                  description: Web Form name already exists
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Web form with name 'Test WebForm' already exists.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - conversations:manage
  /bots/1/testing/start:
    post:
      tags:
      - customer-engagement
      summary: Start test
      description: Start the bot simulation to begin test scenario.
      operationId: start-test
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingStartRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingStartResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - answers:manage
      - answers:testing
      x-is-early-access: true
  /bots/1/testing/{testId}/stop:
    post:
      tags:
      - customer-engagement
      summary: Stop test
      description: Stop the bot simulation to finish test scenario.
      operationId: stop-test
      parameters:
      - name: testId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - answers:manage
      - answers:testing
      x-is-early-access: true
  /bots/1/testing/{testId}/send-message:
    post:
      tags:
      - customer-engagement
      summary: Send message
      description: Send inbound message to active test scenario.
      operationId: send-test-message
      parameters:
      - name: testId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.InboundTestingRequest'
            examples:
              default_whatsapp_text_inbound_message:
                summary: WhatsApp TEXT inbound message
                value:
                  message:
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_image_inbound_message:
                summary: WhatsApp IMAGE inbound message
                value:
                  message:
                    content:
                      url: https://example.com
                      caption: Image caption
                      type: IMAGE
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_document_inbound_message:
                summary: WhatsApp DOCUMENT inbound message
                value:
                  message:
                    content:
                      url: https://example.com
                      caption: Document caption
                      type: DOCUMENT
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_audio_inbound_message:
                summary: WhatsApp AUDIO inbound message
                value:
                  message:
                    content:
                      url: https://example.com
                      caption: Audio caption
                      type: AUDIO
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_video_inbound_message:
                summary: WhatsApp VIDEO inbound message
                value:
                  message:
                    content:
                      url: https://example.com
                      caption: Video caption
                      type: VIDEO
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_voice_inbound_message:
                summary: WhatsApp VOICE inbound message
                value:
                  message:
                    content:
                      url: https://example.com
                      caption: Voice caption
                      type: VOICE
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_location_inbound_message:
                summary: WhatsApp LOCATION inbound message
                value:
                  message:
                    content:
                      latitude: 45.8428647
                      longitude: 15.8819638
                      address: Street address 20, Country
                      name: Location name
                      url: http://example.com
                      type: LOCATION
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_quick_reply_inbound_message:
                summary: WhatsApp QUICK_REPLY inbound message
                value:
                  message:
                    content:
                      text: quick reply
                      payload: payload
                      type: QUICK_REPLY
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_button_reply_inbound_message:
                summary: WhatsApp BUTTON_REPLY inbound message
                value:
                  message:
                    content:
                      id: buttonId
                      title: Button title
                      type: BUTTON_REPLY
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_list_reply_inbound_message:
                summary: WhatsApp LIST_REPLY inbound message
                value:
                  message:
                    content:
                      id: itemId
                      title: Item title
                      description: Item description
                      type: LIST_REPLY
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_flow_reply_inbound_message:
                summary: WhatsApp FLOW_REPLY inbound message
                value:
                  message:
                    content:
                      text: Flow reply
                      response:
                        key1: value1
                        key2: value2
                      type: FLOW_REPLY
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_call_reply_inbound_message:
                summary: WhatsApp CALL_REPLY inbound message
                value:
                  message:
                    content:
                      callResponseType: ACCEPT
                      expiration: 2025-01-01T00:00:00.000+0000
                      type: CALL_REPLY
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_order_inbound_message:
                summary: WhatsApp ORDER inbound message
                value:
                  message:
                    content:
                      catalogId: catalogId
                      items:
                      - currency: id
                        itemPrice: 20
                        productRetailerId: EUR
                        quantity: 10
                      text: Order title
                      type: ORDER
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_whatsapp_contact_inbound_message:
                summary: WhatsApp CONTACT inbound message
                value:
                  message:
                    content:
                      contacts:
                      - addresses:
                        - street: Street name 1
                          city: city name
                          state: state name
                          zip: '123123'
                          country: country name
                          countryCode: HR
                          type: home address
                        birthday: '2024-01-10'
                        emails:
                        - email: example@example.com
                          type: work email
                        name:
                          firstName: John
                          lastName: Doe
                          middleName: Joe
                          nameSuffix: PhD
                          namePrefix: Dr.
                          formattedName: Dr. John Doe
                        organisation:
                          company: company name
                          department: department name
                          title: company title
                        phones:
                        - phone: '38595112233'
                          type: work phone
                          waId: waId
                        urls:
                        - url: https://example.com
                          type: work url
                      type: CONTACT
                    channel: WHATSAPP
                  userDestination: '38595112233'
              default_live_chat_text_inbound_message:
                summary: Live Chat TEXT inbound message
                value:
                  message:
                    content:
                      text: Hello
                      type: TEXT
                    channel: LIVE_CHAT
                  userDestination: '38595112233'
              default_live_chat_audio_inbound_message:
                summary: Live Chat AUDIO inbound message
                value:
                  message:
                    content:
                      url: https://example.com
                      type: AUDIO
                    channel: LIVE_CHAT
                  userDestination: '38595112233'
              default_live_chat_video_inbound_message:
                summary: Live Chat VIDEO inbound message
                value:
                  message:
                    content:
                      url: https://example.com
                      caption: Video caption
                      type: VIDEO
                    channel: LIVE_CHAT
                  userDestination: '38595112233'
              default_live_chat_document_inbound_message:
                summary: Live Chat DOCUMENT inbound message
                value:
                  message:
                    content:
                      url: https://example.com
                      caption: Document caption
                      type: DOCUMENT
                    channel: LIVE_CHAT
                  userDestination: '38595112233'
              default_live_chat_image_inbound_message:
                summary: Live Chat IMAGE inbound message
                value:
                  message:
                    content:
                      url: https://example.com
                      caption: Image caption
                      type: IMAGE
                    channel: LIVE_CHAT
                  userDestination: '38595112233'
              default_live_chat_button_reply_inbound_message:
                summary: Live Chat BUTTON_REPLY inbound message
                value:
                  message:
                    content:
                      text: Button text
                      buttonPayloadType: POSTBACK
                      payload: Button reply payload
                      type: BUTTON_REPLY
                    channel: LIVE_CHAT
                  userDestination: '38595112233'
              default_live_chat_bundle_inbound_message:
                summary: Live Chat BUNDLE inbound message
                value:
                  message:
                    content:
                      content:
                        text: Hello
                        type: TEXT
                      type: BUNDLE
                    channel: LIVE_CHAT
                  userDestination: '38595112233'
              default_calls_start_call_inbound_message:
                summary: Calls START_CALL inbound message
                value:
                  message:
                    content:
                      type: START_CALL
                    channel: CALLS
                  userDestination: '38595112233'
              default_calls_text_inbound_message:
                summary: Calls TEXT inbound message
                value:
                  message:
                    content:
                      text: Hello
                      interrupted: false
                      type: TEXT
                    channel: CALLS
                  userDestination: '38595112233'
              default_calls_hang_up_inbound_message:
                summary: Calls HANG_UP inbound message
                value:
                  message:
                    content:
                      type: HANG_UP
                    channel: CALLS
                  userDestination: '38595112233'
              default_calls_dtmf_code_response_inbound_message:
                summary: Calls DTMF_CODE_RESPONSE inbound message
                value:
                  message:
                    content:
                      text: '1'
                      timeout: false
                      type: DTMF_CODE_RESPONSE
                    channel: CALLS
                  userDestination: '38595112233'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - answers:manage
      - answers:testing
      x-is-early-access: true
  /saas/1/{resourceType}/{resourceId}/export:
    get:
      tags:
      - customer-engagement
      summary: Export SaaS resource
      description: Choose a Saas resource to export and receive the file in the API response.
      operationId: export-saas-resource
      parameters:
      - name: resourceType
        in: path
        description: Type of SaaS resource.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          enum:
          - bot
      - name: resourceId
        in: path
        description: SaaS resource identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            Content-Disposition:
              description: Exported file name.
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/octet-stream:
              schema:
                type: string
                format: byte
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - OAuth2: []
      x-scopes:
      - answers:manage
      x-is-early-access: true
  /saas/1/{resourceType}/import:
    post:
      tags:
      - customer-engagement
      summary: Import SaaS resource
      description: Import a SaaS resource to your account.
      operationId: import-saas-resource
      parameters:
      - name: resourceType
        in: path
        description: Type of SaaS resource.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          enum:
          - bot
      requestBody:
        description: Resource definition.
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
              required:
              - file
            examples:
              Request example:
                summary: Request example
                value: "----bndr\nContent-Disposition: form-data; name=\"file\"; filename=\"bot-1234-982382131.export\"\nContent-Type: application/octet-stream\n\n74AEE8084910ED9207FD67107DE275B43AC04AEEA6                    \n----bndr-- "
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.ImportResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - OAuth2: []
      x-scopes:
      - answers:manage
      x-is-early-access: true
  /saas/1/{resourceType}/{resourceId}/share:
    post:
      tags:
      - customer-engagement
      summary: Share SaaS resource
      description: Use this endpoint to share a SaaS resource with other accounts. You can check the status of your share request [here](https://www.infobip.com/docs/api/customer-engagement/common-assets/saas-request-status).
      operationId: share-saas-resource
      parameters:
      - name: resourceType
        in: path
        description: Type of SaaS resource.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          enum:
          - bot
      - name: resourceId
        in: path
        description: SaaS resource identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Accounts to share the resource with.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.ShareRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.ShareResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - OAuth2: []
      x-scopes:
      - answers:manage
      x-is-early-access: true
  /saas/1/request/{requestId}/status:
    get:
      tags:
      - customer-engagement
      summary: Get SaaS request status
      description: Get the status of your share request.
      operationId: saas-request-status
      parameters:
      - name: requestId
        in: path
        description: Identifier of user request on SaaS.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.RequestStatusResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - OAuth2: []
      x-scopes:
      - answers:manage
      x-is-early-access: true
  /vocalize/2/campaigns/me:
    get:
      tags:
      - customer-engagement
      summary: Get my campaigns
      description: Get all campaigns for the authenticated user.
      operationId: vocalize-get-my-campaigns
      parameters:
      - name: activeOnly
        in: query
        description: If true, only return active campaigns. Defaults to false.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          description: If true, only return active campaigns. Defaults to false.
          title: Activeonly
      - name: hasScores
        in: query
        description: If true, only return campaigns that have scores associated with them. Defaults to false.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          description: If true, only return campaigns that have scores associated with them. Defaults to false.
          title: Hasscores
      responses:
        '200':
          description: Campaigns successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignListResponse'
              examples:
                Standard Campaigns Response:
                  summary: Standard Campaigns Response
                  value:
                    campaigns:
                    - name: Greetings Campaign
                      keywordSpec:
                        en-US: Hello from Infobip
                        es-ES: Hola desde Infobip
                      activeFrom: '2026-06-01T14:00:00Z'
                      activeUntil: '2026-07-01T14:00:00Z'
                      settings:
                        maxDailyAttemptsPerUser: 100
                        sttModelProvider: AZURE
                        maxDailyAttemptsPerCampaign: 85000
                      id: 01234567-89ab-cdef-0123-456789abcdef
                      accountId: '123'
                      dateCreated: '2026-03-28T14:48:45.869219'
                    - name: Onboarding Campaign
                      keywordSpec:
                        en-US: Welcome to Infobip
                        es-ES: Bienvenido a Infobip
                      activeFrom: '2026-08-10T09:00:00Z'
                      activeUntil: '2026-09-10T09:00:00Z'
                      settings:
                        maxDailyAttemptsPerUser: 75
                        sttModelProvider: GOOGLE
                        maxDailyAttemptsPerCampaign: 60000
                      id: abcdef12-3456-7890-abcd-ef1234567890
                      accountId: '456'
                      dateCreated: '2026-04-15T10:22:13.567890'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - APIKeyHeader: []
      x-scopes: []
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 1
        timeUnit: s
  /vocalize/2/campaigns:
    post:
      tags:
      - customer-engagement
      summary: Create campaign
      description: Create a new campaign with the specified parameters.
      operationId: vocalize-create-campaign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignCreatePayload'
              description: Campaign definition.
            examples:
              Basic create campaign request:
                summary: Basic create campaign request
                value:
                  name: Voice Training Challenge 2025
                  keywordSpec:
                    en-US: Hello world, welcome to our voice training program
                    es-ES: Hola mundo, bienvenidos a nuestro programa de entrenamiento vocal
                    fr-FR: Bonjour le monde, bienvenue dans notre programme d'entraînement vocal
                  activeFrom: '2025-07-15T09:00:00Z'
                  activeUntil: '2025-08-15T18:00:00Z'
                  settings:
                    maxDailyAttemptsPerUser: 10
                    sttModelProvider: AZURE
                    maxDailyAttemptsPerCampaign: 500
                  imageUrl: www.example.com/campaign-banner.png
              Create campaign with alternative settings:
                summary: Create campaign with alternative settings
                value:
                  name: Pronunciation Assessment Workshop
                  keywordSpec:
                    en-US: The quick brown fox jumps over the lazy dog
                    de-DE: Der schnelle braune Fuchs springt über den faulen Hund
                    ja-JP: 素早い茶色のキツネが怠け者の犬を飛び越える
                  activeFrom: '2025-08-01T06:30:00Z'
                  activeUntil: '2025-09-30T23:59:59Z'
                  settings:
                    maxDailyAttemptsPerUser: 5
                    sttModelProvider: GOOGLE
                    maxDailyAttemptsPerCampaign: 2000
                  imageUrl: www.example.com/alt-banner.jpg
              Create campaign - keyword spec only:
                summary: Create campaign - keyword spec only
                value:
                  name: Daily Vocabulary Practice
                  keywordSpec:
                    en-US: Communication is key to success
                  activeFrom: '2025-07-10T08:00:00Z'
                  activeUntil: '2025-07-20T20:00:00Z'
                  settings:
                    maxDailyAttemptsPerUser: 15
                    sttModelProvider: AZURE
                    maxDailyAttemptsPerCampaign: 750
          examples: {}
        required: true
      responses:
        '201':
          description: Campaign successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignResponse'
              examples:
                Standard Campaign created response:
                  summary: Standard Campaign created response
                  value:
                    name: Greetings Campaign
                    keywordSpec:
                      en-US: Hello from Infobip
                      es-ES: Hola desde Infobip
                    activeFrom: '2026-06-01T14:00:00Z'
                    activeUntil: '2026-07-01T14:00:00Z'
                    settings:
                      maxDailyAttemptsPerUser: 100
                      sttModelProvider: AZURE
                      maxDailyAttemptsPerCampaign: 85000
                    id: 01234567-89ab-cdef-0123-456789abcdef
                    accountId: '123'
                    dateCreated: '2026-03-28T14:48:45.869219'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - APIKeyHeader: []
      x-scopes: []
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 1
        timeUnit: s
  /vocalize/2/campaigns/{campaignId}:
    get:
      tags:
      - customer-engagement
      summary: Get campaign
      description: Get a campaign by its ID.
      operationId: vocalize-get-campaign
      parameters:
      - name: campaignId
        in: path
        description: The UUID of the campaign to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The UUID of the campaign to retrieve.
          title: Campaignid
      responses:
        '200':
          description: Campaign with ID successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignResponse'
              examples:
                Standard Campaign by ID response:
                  summary: Standard Campaign by ID response
                  value:
                    name: Greetings Campaign
                    keywordSpec:
                      en-US: Hello from Infobip
                      es-ES: Hola desde Infobip
                    activeFrom: '2026-06-01T14:00:00Z'
                    activeUntil: '2026-07-01T14:00:00Z'
                    settings:
                      maxDailyAttemptsPerUser: 42
                      sttModelProvider: GOOGLE
                      maxDailyAttemptsPerCampaign: 420
                    imageUrl: https://www.example.com/image.jpg
                    id: 01234567-89ab-cdef-0123-456789abcdef
                    accountId: '123'
                    dateCreated: '2026-03-28T14:48:45.869219'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - APIKeyHeader: []
      x-scopes: []
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 1
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete campaign
      description: Delete a campaign with the specified ID.
      operationId: vocalize-delete-campaign
      parameters:
      - name: campaignId
        in: path
        description: The UUID of the campaign to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The UUID of the campaign to delete.
          title: Campaignid
      responses:
        '204':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - APIKeyHeader: []
      x-scopes: []
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 1
        timeUnit: s
  /vocalize/2/campaigns/{campaignId}/settings:
    patch:
      tags:
      - customer-engagement
      summary: Update campaign settings
      description: Update the settings of a campaign with the specified ID.
      operationId: vocalize-update-campaign-settings
      parameters:
      - name: campaignId
        in: path
        description: The UUID of the campaign to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The UUID of the campaign to update.
          title: Campaignid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignSettings'
              description: Settings to update for the campaign.
            examples:
              Update campaign settings:
                summary: Update campaign settings
                value:
                  maxDailyAttemptsPerUser: 15
                  sttModelProvider: GOOGLE
                  maxDailyAttemptsPerCampaign: 1000
              Update campaign settings partially:
                summary: Update campaign settings partially
                value:
                  maxDailyAttemptsPerUser: 8
          examples: {}
        required: true
      responses:
        '200':
          description: Campaign setting successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignResponse'
              examples:
                Standard Campaign settings updated response:
                  summary: Standard Campaign settings updated response
                  value:
                    name: Greetings Campaign
                    keywordSpec:
                      en-US: Hello from Infobip
                      es-ES: Hola desde Infobip
                    activeFrom: '2026-06-01T14:00:00Z'
                    activeUntil: '2026-07-01T14:00:00Z'
                    settings:
                      maxDailyAttemptsPerUser: 42
                      sttModelProvider: GOOGLE
                      maxDailyAttemptsPerCampaign: 420
                    imageUrl: https://www.example.com/image.jpg
                    id: 01234567-89ab-cdef-0123-456789abcdef
                    accountId: '123'
                    dateCreated: '2026-03-28T14:48:45.869219'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - APIKeyHeader: []
      x-scopes: []
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 1
        timeUnit: s
  /vocalize/2/campaigns/{campaignId}/leaderboard:
    get:
      tags:
      - customer-engagement
      summary: Get campaign leaderboard
      description: Get leaderboard for a campaign, sorted by score. Additional query parameters can be used to filter and paginate the results. Filter by fromTime and toTime to get scores within a specific time range. Filter by day to get scores for a specific day of the campaign. You cannot use both fromTime/toTime and day together. If no filters are provided, the leaderboard will show all scores for the campaign, paginated. Users who have not provided their name will not be included in the leaderboard.
      operationId: vocalize-get-campaign-leaderboard
      parameters:
      - name: campaignId
        in: path
        description: The UUID of the campaign to retrieve the leaderboard for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The UUID of the campaign to retrieve the leaderboard for.
          title: Campaignid
      - name: page
        in: query
        description: Page number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 0
          description: Page number.
          minimum: 0
          title: Page
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 10
          description: Number of records per page.
          exclusiveMinimum: 0
          maximum: 100
          title: Size
      - name: fromTime
        in: query
        description: 'Start time for filtering scores (datetime, ISO string, or Unix timestamp). Example value: 2023-10-01T00:00:00Z.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'Start time for filtering scores (datetime, ISO string, or Unix timestamp). Example value: 2023-10-01T00:00:00Z.'
          title: Fromtime
      - name: toTime
        in: query
        description: 'End time for filtering scores (datetime, ISO string, or Unix timestamp). Example value: 2023-10-31T23:59:59Z.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'End time for filtering scores (datetime, ISO string, or Unix timestamp). Example value: 2023-10-31T23:59:59Z.'
          title: Totime
      - name: day
        in: query
        description: Retrieves scores for a specific day. Can't be used with fromTime/toTime. Days count starts at 0, which means that the API will return scores for the first day of the campaign.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          description: Retrieves scores for a specific day. Can't be used with fromTime/toTime. Days count starts at 0, which means that the API will return scores for the first day of the campaign.
          title: Day
      responses:
        '200':
          description: Leaderboard retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.LeaderboardResponse'
              examples:
                Leaderboard Response:
                  summary: Leaderboard Response
                  value:
                    scores:
                    - name: John Doe
                      userId: '12345'
                      score: 900
                      date: '2026-06-15T10:00:00Z'
                    - name: Jane Smith
                      userId: '67890'
                      score: 600
                      date: '2026-06-15T10:05:00Z'
                    paging:
                      page: 1
                      size: 10
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - APIKeyHeader: []
      x-scopes: []
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 1
        timeUnit: s
  /vocalize/2/campaigns/{campaignId}/stats:
    get:
      tags:
      - customer-engagement
      summary: Get campaign statistics
      description: Get statistics for a campaign, including total scores, attempts, and more.
      operationId: vocalize-get-campaign-stats
      parameters:
      - name: campaignId
        in: path
        description: The UUID of the campaign to retrieve statistics for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The UUID of the campaign to retrieve statistics for.
          title: Campaignid
      responses:
        '200':
          description: Successfully retrieved campaign stats
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignStatsResponse'
              examples:
                Standard Campaign Stats Response:
                  summary: Standard Campaign Stats Response
                  value:
                    numberOfParticipants: 147
                    averageScore: 780.0
                    lowestScore: 230.0
                    highestScore: 980.0
                    numberOfAttempts: 892
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - APIKeyHeader: []
      x-scopes: []
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 1
        timeUnit: s
  /vocalize/2/campaigns/{campaignId}/reset:
    delete:
      tags:
      - customer-engagement
      summary: Delete campaign scores
      description: Delete all scores and attempts for a campaign with the specified ID. This action cannot be undone.
      operationId: vocalize-reset-campaign
      parameters:
      - name: campaignId
        in: path
        description: The UUID of the campaign to reset.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The UUID of the campaign to reset.
          title: Campaignid
      responses:
        '204':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - APIKeyHeader: []
      x-scopes: []
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 1
        timeUnit: s
  /vocalize/2/scores:
    put:
      tags:
      - customer-engagement
      summary: Update score
      description: This endpoint allows users to create or update their score for a specific campaign. If it is the first attempt of the user, the name parameter can be omited.
      operationId: vocalize-submit-entry
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreBase'
              description: Score data to be submitted or updated.
            examples:
              Basic create or update score:
                summary: Basic create or update score
                value:
                  campaignId: 123e4567-e89b-12d3-a456-426614174000
                  userId: 00387123456
                  name: John Doe
                  audioUrl: https://example.com/audio/user-recording-2025-07-08-12345.wav
                  languageCode: en-US
              Create or update score without name (only valid if first attempt of user):
                summary: Create or update score without name (only valid if first attempt of user)
                value:
                  campaignId: 987fcdeb-51a2-43f1-b9c8-765432109876
                  userId: 00491234567890
                  audioUrl: https://storage.example.com/recordings/pronunciation_test_20250708_143502.mp3
                  languageCode: es-ES
          examples: {}
        required: true
      responses:
        '200':
          description: Score successfully created or updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreResponse'
              examples:
                Standard Create or update score response:
                  summary: Standard Create or update score response
                  value:
                    score:
                      campaignId: 987fcdeb-51a2-43f1-b9c8-765432109876
                      userId: 00491234567890
                      name: Maria Garcia
                      audioUrl: https://storage.example.com/recordings/pronunciation_test_20250708_143502.mp3
                      languageCode: es-ES
                      keywordScore: 0.65
                      finalScore: 735
                      transcribedAudio: Hola mundo, bienvenidos a nuestro programa
                      attempts: 1
                      dateModified: '2025-07-08T14:45:18.987654Z'
                      bestScore: 735
                    stats:
                      position: 45
                      rank: 45
                      tiedWith: 1
                      bestScore: 735
                      attempts: 1
                      attemptsRemaining: 14
                      nextScoreToBeat: 742
                      numberOfParticipants: 1500
                Standard Create or update score response 2 - best player:
                  summary: Standard Create or update score response 2 - best player
                  value:
                    score:
                      campaignId: 456789ab-cdef-1234-5678-90abcdef1234
                      userId: '447700123456'
                      audioUrl: https://cdn.example.com/voice-samples/sample_2025_07_08.wav
                      languageCode: fr-FR
                      keywordScore: 0.98
                      shapeScore: 0.95
                      finalScore: 967
                      transcribedAudio: Bonjour le monde, bienvenue dans notre programme
                      attempts: 8
                      dateModified: '2025-07-08T15:12:45.456789Z'
                      bestScore: 963
                    stats:
                      position: 1
                      rank: 1
                      tiedWith: 0
                      bestScore: 963
                      attempts: 8
                      attemptsRemaining: 2
                      numberOfParticipants: 1500
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - APIKeyHeader: []
      x-scopes: []
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 1
        timeUnit: s
  /vocalize/2/scores/stats:
    get:
      tags:
      - customer-engagement
      summary: Get user score statistics
      description: This endpoint retrieves score statistics for a specific user in a campaign.
      operationId: vocalize-get-score-stats
      parameters:
      - name: campaignId
        in: query
        description: ID of the campaign to get score stats for.
        required: true
        style: form
        explode: true
        schema:
          type: string
          format: uuid
          description: ID of the campaign to get score stats for.
          title: Campaignid
      - name: userId
        in: query
        description: User ID, a unique identifier for the user.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: User ID, a unique identifier for the user.
          minLength: 1
          title: Userid
      responses:
        '200':
          description: Score stats successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreStatsResponse'
              examples:
                Standard Get score stats response:
                  summary: Standard Get score stats response
                  value:
                    position: 45
                    rank: 45
                    tiedWith: 8
                    bestScore: 623
                    attempts: 5
                    attemptsRemaining: 10
                    nextScoreToBeat: 631
                    numberOfParticipants: 1500
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - APIKeyHeader: []
      x-scopes: []
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 1
        timeUnit: s
  /knowledge-base/1/search:
    post:
      tags:
      - customer-engagement
      summary: Search knowledge base
      description: Performs a full-text search across all knowledge base content using filter criteria provided in the request body. Results are paginated.
      operationId: search-knowledge-base
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 5000
          minimum: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.SearchCriteria'
        required: true
      responses:
        '200':
          description: Search results returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageCatalogRecordListItemResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/articles:
    get:
      tags:
      - customer-engagement
      summary: Get articles
      description: Returns a paginated list of articles. Optionally filter by search expression, tag, or workflow status. Results are sorted by last updated date in descending order by default.
      operationId: get-articles
      parameters:
      - name: searchExp
        in: query
        description: Search expression to filter articles by name or content.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: SMS API
      - name: tag
        in: query
        description: Filter articles by tag name.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: sms
      - name: status
        in: query
        description: Filter by workflow status.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus'
        example: PUBLISHED
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 5000
          minimum: 1
      - name: sort
        in: query
        description: 'Sort criteria in format ''field,direction''. Sortable fields: name, createdAt, lastUpdatedAt, workflowStatus, lastPublishedAt.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          default: lastUpdatedAt,desc
        example: lastUpdatedAt,desc
      responses:
        '200':
          description: Articles returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageArticleListItemResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Create article
      description: Creates a new knowledge base article with the provided content, tags, and category assignment.
      operationId: create-article
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateUpdateArticleRequest'
        required: true
      responses:
        '201':
          description: Article created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleRefResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/articles/{articleId}:
    get:
      tags:
      - customer-engagement
      summary: Get article
      description: Returns the full details of a specific article including its content, metadata, and tags. Optionally records a view for analytics.
      operationId: get-article
      parameters:
      - name: articleId
        in: path
        description: Unique identifier of the article.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      - name: recordView
        in: query
        description: Whether to record a page view for analytics.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: true
        example: true
      responses:
        '200':
          description: Article details returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleDetailResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - customer-engagement
      summary: Update article
      description: Updates an existing knowledge base article with the provided content, tags, and category assignment.
      operationId: update-article
      parameters:
      - name: articleId
        in: path
        description: Unique identifier of the article.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateUpdateArticleRequest'
        required: true
      responses:
        '200':
          description: Article updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleRefResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete article
      description: Soft-deletes a knowledge base article by its identifier.
      operationId: delete-article
      parameters:
      - name: articleId
        in: path
        description: Unique identifier of the article.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '204':
          description: Article deleted successfully
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/articles/{articleId}/status:
    patch:
      tags:
      - customer-engagement
      summary: Update article status
      description: Changes the workflow status of an article to PUBLISHED or DRAFT.
      operationId: update-article-status
      parameters:
      - name: articleId
        in: path
        description: Unique identifier of the article.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UpdateArticleStatusRequest'
        required: true
      responses:
        '200':
          description: Article status updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleRefResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/articles/{articleId}/history:
    get:
      tags:
      - customer-engagement
      summary: Get article versions
      description: Returns a paginated list of historical versions for a specific article, sorted by version ID in descending order by default.
      operationId: get-article-versions
      parameters:
      - name: articleId
        in: path
        description: Unique identifier of the article.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 5000
          minimum: 1
      - name: sort
        in: query
        description: Sort criteria in format 'field,direction'.
        required: false
        style: form
        explode: true
        schema:
          type: string
          default: catalogRecordVersionId,desc
        example: catalogRecordVersionId,desc
      responses:
        '200':
          description: Article versions returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageArticleVersionDetailResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/articles/{articleId}/comments:
    get:
      tags:
      - customer-engagement
      summary: Get article comments
      description: Returns all comments for a specific article.
      operationId: get-article-comments
      parameters:
      - name: articleId
        in: path
        description: Unique identifier of the article.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: Comments returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentListItemResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Create comment
      description: Adds a new comment to a specific article.
      operationId: create-article-comment
      parameters:
      - name: articleId
        in: path
        description: Unique identifier of the article.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentCreateUpdateRequest'
        required: true
      responses:
        '201':
          description: Comment created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentRefResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/articles/{articleId}/comments/{commentId}:
    put:
      tags:
      - customer-engagement
      summary: Update comment
      description: Updates the content of a specific comment on an article.
      operationId: update-article-comment
      parameters:
      - name: articleId
        in: path
        description: Unique identifier of the article.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      - name: commentId
        in: path
        description: Unique identifier of the comment.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 1fa85f64-5717-4562-b3fc-2c963f66afa6
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentCreateUpdateRequest'
        required: true
      responses:
        '200':
          description: Comment updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentRefResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete comment
      description: Deletes a specific comment from an article. Only the comment author or users with manage permissions can delete.
      operationId: delete-article-comment
      parameters:
      - name: articleId
        in: path
        description: Unique identifier of the article.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      - name: commentId
        in: path
        description: Unique identifier of the comment.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 1fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '204':
          description: Comment deleted successfully
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/categories:
    get:
      tags:
      - customer-engagement
      summary: Get categories
      description: Returns a paginated list of categories. Optionally filter by category name or content scope. Results are sorted by name in ascending order by default.
      operationId: get-categories
      parameters:
      - name: name
        in: query
        description: Filter categories by name.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: API Guides
      - name: scope
        in: query
        description: Filter categories by content scope.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope'
        example: INTERNAL
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 5000
          minimum: 1
      - name: sort
        in: query
        description: Sort criteria in format 'field,direction'.
        required: false
        style: form
        explode: true
        schema:
          type: string
          default: name,asc
        example: name,asc
      responses:
        '200':
          description: Categories returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageCategoryItemResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/folders:
    get:
      tags:
      - customer-engagement
      summary: Get folders
      description: Returns a paginated list of folders. Optionally filter by folder name or category. Results are sorted by name in ascending order by default.
      operationId: get-folders
      parameters:
      - name: name
        in: query
        description: Filter folders by name.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Getting Started
      - name: categoryId
        in: query
        description: Filter folders by category identifier.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 5000
          minimum: 1
      - name: sort
        in: query
        description: Sort criteria in format 'field,direction'.
        required: false
        style: form
        explode: true
        schema:
          type: string
          default: name,asc
        example: name,asc
      responses:
        '200':
          description: Folders returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageFolderItemResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/content-tree/nodes/categories:
    get:
      tags:
      - customer-engagement
      summary: Get content tree categories
      description: Returns a paginated list of top-level category nodes in the content tree. Optionally expand the tree to a specific node. Results are sorted by position in ascending order by default.
      operationId: get-content-tree-categories
      parameters:
      - name: expandedToNodeId
        in: query
        description: Expand the tree to include the path to this node.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 5000
          minimum: 1
      - name: sort
        in: query
        description: Sort criteria in format 'field,direction'.
        required: false
        style: form
        explode: true
        schema:
          type: string
          default: position,asc
        example: position,asc
      responses:
        '200':
          description: Content tree categories returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageTreeNodeResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/content-tree/nodes:
    post:
      tags:
      - customer-engagement
      summary: Create content tree node
      description: Creates a new node in the content tree.
      operationId: create-content-tree-node
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateTreeNodeRequest'
        required: true
      responses:
        '201':
          description: Content tree node created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/content-tree/nodes/{nodeId}/move:
    post:
      tags:
      - customer-engagement
      summary: Move content tree node
      description: Moves a content tree node to a new position relative to a target node.
      operationId: move-content-tree-node
      parameters:
      - name: nodeId
        in: path
        description: Unique identifier of the node to move.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.MoveTreeNodeRequest'
        required: true
      responses:
        '200':
          description: Content tree node moved successfully
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/content-tree/nodes/{nodeId}:
    get:
      tags:
      - customer-engagement
      summary: Get content tree node
      description: Returns the direct children of a specific content tree node.
      operationId: get-content-tree-node
      parameters:
      - name: nodeId
        in: path
        description: Unique identifier of the tree node.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: Child nodes returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - customer-engagement
      summary: Update content tree node
      description: Updates an existing content tree node.
      operationId: update-content-tree-node
      parameters:
      - name: nodeId
        in: path
        description: Unique identifier of the tree node.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UpdateTreeNodeRequest'
        required: true
      responses:
        '200':
          description: Content tree node updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete content tree node
      description: Deletes a content tree node and its children.
      operationId: delete-content-tree-node
      parameters:
      - name: nodeId
        in: path
        description: Unique identifier of the tree node.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '204':
          description: Content tree node deleted successfully
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/tags:
    get:
      tags:
      - customer-engagement
      summary: Get tags
      description: Returns a paginated list of tags. Optionally filter by tag name. Results are sorted by last updated date in descending order by default.
      operationId: get-knowledge-base-tags
      parameters:
      - name: name
        in: query
        description: Filter tags by name.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: sms
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 5000
          minimum: 1
      - name: sort
        in: query
        description: 'Sort criteria in format ''field,direction''. Sortable fields: name, createdAt, lastUpdatedAt, referencesCount.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          default: lastUpdatedAt,desc
        example: lastUpdatedAt,desc
      responses:
        '200':
          description: Tags returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageTagListItemResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Create tag
      description: Creates a new tag with the given name. Tag name must not contain comma characters.
      operationId: create-knowledge-base-tag
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagCreateRequest'
        required: true
      responses:
        '201':
          description: Tag created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagRefResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/tags/{tagId}:
    get:
      tags:
      - customer-engagement
      summary: Get tag
      description: Returns the details of a specific tag by its identifier.
      operationId: get-knowledge-base-tag
      parameters:
      - name: tagId
        in: path
        description: Unique identifier of the tag.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: Tag returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagListItemResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - customer-engagement
      summary: Update tag
      description: Renames an existing tag.
      operationId: update-knowledge-base-tag
      parameters:
      - name: tagId
        in: path
        description: Unique identifier of the tag.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagUpdateRequest'
        required: true
      responses:
        '200':
          description: Tag updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagRefResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/attachments/{attachmentId}:
    get:
      tags:
      - customer-engagement
      summary: Get attachment details
      description: Returns the details of a specific attachment including its metadata and download URL.
      operationId: get-attachment-details
      parameters:
      - name: attachmentId
        in: path
        description: Unique identifier of the attachment.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: Attachment details returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentDetailResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - customer-engagement
      summary: Delete attachment
      description: Deletes an attachment by its identifier.
      operationId: delete-attachment
      parameters:
      - name: attachmentId
        in: path
        description: Unique identifier of the attachment.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '204':
          description: Attachment deleted successfully
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/attachments/{attachmentId}/linked-article:
    get:
      tags:
      - customer-engagement
      summary: Get attachment linked article
      description: Returns the article that is linked to a specific attachment.
      operationId: get-attachment-linked-article
      parameters:
      - name: attachmentId
        in: path
        description: Unique identifier of the attachment.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: Linked article returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentLinkedArticleResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:read
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /knowledge-base/1/attachments:
    post:
      tags:
      - customer-engagement
      summary: Upload attachment
      description: Uploads a file as a new knowledge base attachment. The file is validated and stored.
      operationId: upload-attachment
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
              required:
              - file
      responses:
        '201':
          description: Attachment uploaded successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentDetailResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - knowledge-base:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
webhooks:
  receive-test-message:
    post:
      tags:
      - customer-engagement
      summary: Receive testing message
      description: Incoming test messages will be forwarded to this endpoint. For now supported channels are WhatsApp, Live Chat and Calls.
      operationId: receive-test-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicAnswersEventExample'
            examples:
              default_whatsapp_text_event:
                summary: WhatsApp TEXT event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      text: Hello
                      showPreview: false
                      type: TEXT
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - TEXT
              default_whatsapp_image_event:
                summary: WhatsApp IMAGE event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      url: https://example.com/image.jpg
                      caption: image_caption
                      type: IMAGE
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - IMAGE
              default_whatsapp_document_event:
                summary: WhatsApp DOCUMENT event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      url: https://example.com/document.pdf
                      caption: document_caption
                      filename: document.pdf
                      type: DOCUMENT
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - DOCUMENT
              default_whatsapp_audio_event:
                summary: WhatsApp AUDIO event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      url: https://example.com/audio.mp3
                      type: AUDIO
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - AUDIO
              default_whatsapp_video_event:
                summary: WhatsApp VIDEO event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      url: https://example.com/video.mp4
                      caption: video_caption
                      type: VIDEO
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - VIDEO
              default_whatsapp_url_button_event:
                summary: WhatsApp URL_BUTTON event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      header: header
                      body: body
                      footer: footer
                      displayText: display_text
                      url: https://example.com/button/content
                      type: URL_BUTTON
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - URL_BUTTON
              default_whatsapp_location_event:
                summary: WhatsApp LOCATION event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      latitude: 45.793668123
                      longitude: -73.123456789
                      name: location_name
                      address: location_address
                      type: LOCATION
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - LOCATION
              default_whatsapp_location_request_event:
                summary: WhatsApp LOCATION_REQUEST event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      body: body
                      type: LOCATION_REQUEST
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - LOCATION_REQUEST
              default_whatsapp_sticker_event:
                summary: WhatsApp STICKER event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      url: https://example.com/sticker.png
                      type: STICKER
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - STICKER
              default_whatsapp_button_event:
                summary: WhatsApp BUTTON event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      header:
                        text: header
                        type: TEXT
                      body: body
                      footer: footer
                      actions:
                      - id: id
                        title: title
                      type: BUTTON
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - BUTTON
              default_whatsapp_list_event:
                summary: WhatsApp LIST event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      header:
                        text: header
                        type: TEXT
                      body: body
                      footer: footer
                      button: button
                      sections:
                      - title: title
                        items:
                        - id: id
                          title: title
                          description: description
                      type: LIST
                    channel: WHATSAPP
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - WhatsApp
                  message type:
                  - LIST
              default_live_chat_text_event:
                summary: Live Chat TEXT event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      text: Hello
                      type: TEXT
                    channel: LIVE_CHAT
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Live Chat
                  message type:
                  - TEXT
              default_live_chat_image_event:
                summary: Live Chat IMAGE event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      url: https://example.com/image.jpg
                      caption: image_caption
                      type: IMAGE
                    channel: LIVE_CHAT
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Live Chat
                  message type:
                  - IMAGE
              default_live_chat_document_event:
                summary: Live Chat DOCUMENT event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      url: https://example.com/document.pdf
                      caption: document_caption
                      type: DOCUMENT
                    channel: LIVE_CHAT
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Live Chat
                  message type:
                  - DOCUMENT
              default_live_chat_audio_event:
                summary: Live Chat AUDIO event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      url: https://example.com/audio.mp3
                      type: AUDIO
                    channel: LIVE_CHAT
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Live Chat
                  message type:
                  - AUDIO
              default_live_chat_video_event:
                summary: Live Chat VIDEO event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      url: https://example.com/video.mp4
                      caption: video_caption
                      type: VIDEO
                    channel: LIVE_CHAT
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Live Chat
                  message type:
                  - VIDEO
              default_live_chat_button_event:
                summary: Live Chat BUTTON event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      text: text
                      url: https://example.com/
                      buttons:
                      - title: title
                        payload: payload
                        type: URL
                      type: BUTTON
                    channel: LIVE_CHAT
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Live Chat
                  message type:
                  - BUTTON
              default_live_chat_carousel_event:
                summary: Live Chat CAROUSEL event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      cards:
                      - title: title
                        image: image
                        imageUrl: url
                        actions:
                        - title: title
                          payload: payload
                          type: URL
                      quickReplies:
                      - reply
                      type: CAROUSEL
                    channel: LIVE_CHAT
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Live Chat
                  message type:
                  - CAROUSEL
              default_calls_text_event:
                summary: Calls TEXT event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      text: Hello
                      canBeInterrupted: false
                      type: TEXT
                    channel: CALLS
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Calls
                  message type:
                  - TEXT
              default_calls_file_event:
                summary: Calls FILE event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      url: https://example.com/file.pdf
                      type: FILE
                    channel: CALLS
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Calls
                  message type:
                  - FILE
              default_calls_hang_up_event:
                summary: Calls HANG_UP event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      type: HANG_UP
                    channel: CALLS
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Calls
                  message type:
                  - HANG_UP
              default_calls_dtmf_code_request_event:
                summary: Calls DTMF_CODE_REQUEST event
                value:
                  accountKey: 6828B51B5FC42873D3E5434FA42F62FF
                  sessionInformation:
                    botInformation:
                      botId: 1
                      botSender: WEB_SIMULATION
                      botName: testing bot
                      channel: WHATSAPP
                      testId: 12345
                    endUserDestination: '38595112233'
                    sessionId: 123e4567-e89b-12d3-a456-426614174000
                    externalId: TESTING
                    externalMetadata: {}
                    callbackData: callback_data_example
                  timestamp: 2023-01-01T00:00:00.000+0000
                  lastDialog:
                    id: 1
                    name: dialog_name
                  outboundMessage:
                    content:
                      text: Hello
                      dtmfMaxCodeLength: 10
                      dtmfTerminator: '#'
                      timeoutSeconds: 15
                      type: DTMF_CODE_REQUEST
                    channel: CALLS
                  type: MESSAGE_SENT
                x-label:
                  channel:
                  - Calls
                  message type:
                  - DTMF_CODE_REQUEST
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  cdp-event-webhook:
    post:
      tags:
      - customer-engagement
      summary: People Webhook
      description: Webhook triggered when there is any new event on platform that your application should handle.
      operationId: cdp-event-webhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.CDPWebhookReport'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  conversation-event-webhook:
    post:
      tags:
      - customer-engagement
      summary: Conversations Webhook
      description: '

        Webhooks are automated notifications sent between applications when specific events occur. They enable real-time communication by transmitting data through HTTP requests.


        Conversations webhooks provide instant access to conversation details and the latest message information, allowing you to manage customer inquiries efficiently. They support real-time integrations to automate workflows for message routing, escalation, and analytics, enhancing operational reporting with comprehensive conversation and message-level metadata.


        With these webhooks, you can receive notifications for incoming messages and conversational events through [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management).


        On our [web interface](https://portal.infobip.com/login), go to Subscriptions Management → Create subscription. Choose the Customer engagement option in the Channel menu and select the events you want to subscribe to.

        Additionally, you can use the [Subscriptions Management API](https://www.infobip.com/docs/api/platform/subscriptions-api) endpoints to create the wanted subscriptions.


        '
      operationId: conversation-event-webhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationWebhookReport'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
components:
  schemas:
    8a96177a069f927b552e6f478d6833812472502f930c109564e4f89f3264faaa.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse:
      type: object
      properties:
        statusCode:
          $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCode'
        message:
          type: string
      title: StatusCodeResponse
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionDto:
      type: object
      description: Specify in which timespan did the event occur.
      properties:
        occurred:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionOccurred'
        operator:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionOperator'
        start:
          type: integer
          format: int32
          description: 'Start of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp.'
          example: 60
        end:
          type: integer
          format: int32
          description: 'End of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp.'
          example: 30
        units:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionUnits'
      required:
      - occurred
      - operator
      title: TimelineConditionDto
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIErrorViolations:
      type: object
      properties:
        property:
          type: string
          description: Request property that caused the error.
          title: Property
        violation:
          type: string
          description: Detailed violation description.
          title: Violation
      required:
      - property
      - violation
      title: APIErrorViolations
    c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResult:
      type: object
      properties:
        errors:
          type: array
          description: List of errors
          items:
            $ref: '#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError'
          readOnly: false
          writeOnly: false
        index:
          type: integer
          format: int32
          description: Index of person in request list
          readOnly: false
          writeOnly: false
        status:
          type: integer
          format: int32
          description: HTTP status
          readOnly: false
          writeOnly: false
      title: BatchCreateResult
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamIntegrationsV2:
      type: object
      description: Integrations.
      properties:
        salesforce:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamSalesforceV2'
      title: IamIntegrationsV2
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.SessionInformationExample:
      type: object
      description: Details about session.
      properties:
        botInformation:
          $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.BotInformationExample'
        endUserDestination:
          type: string
          description: End-user destination.
        sessionId:
          type: string
          format: uuid
          description: Unique session identifier.
        externalId:
          type: string
          description: External identifier.
        externalMetadata:
          type: object
          additionalProperties:
            type: object
          description: External metadata.
        callbackData:
          type: string
          description: Callback data from last received message.
      required:
      - botInformation
      - callbackData
      - endUserDestination
      - externalId
      - externalMetadata
      - sessionId
      title: SessionInformationExample
    a1a8ff0e2d4e8815c87f131be18d5198cdc635a778df6b963f0f0a4b59822f94.ExportRequestBody:
      type: object
      properties:
        roleArn:
          type: string
          description: 'AWS role ARN for accessing S3 bucket. Accepted format: `arn:aws:iam::account:role/role-name-with-path`. Must apply character rules as referenced in [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html).'
          writeOnly: true
        bucket:
          type: string
          description: AWS S3 bucket name. Must only contain safe characters, as defined in [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html).
          writeOnly: true
        region:
          type: string
          description: AWS S3 client region.
          writeOnly: true
        directoryPath:
          type: string
          description: AWS S3 directory path. Use `directory/` or a nested directory path `dir1/dir2/directory/`. Must only contain safe characters or an equal sign, as defined in [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html).
          writeOnly: true
        startTime:
          type: string
          description: 'Start time of the export query. Accepted format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`, e.g. `2022-03-01T01:00:00.000+0000`. Must be earlier than the current time and `endTime`, but no more than 1 year ago. `startTime` and `endTime` must be at most 24 hours apart.'
          writeOnly: true
        endTime:
          type: string
          description: 'End time of the export query. Accepted format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`, e.g. `2022-03-01T01:00:00.000+0000`. Must be earlier than the current time, and later than `startTime`. `startTime` and `endTime` must be at most 24 hours apart.'
          writeOnly: true
        definitionIdList:
          type: array
          description: 'An optional list of `definitionId`s to use as a whitelist filter for exported events. Accepted format: `["definitionId", "definitionId"]`, e.g. `["formSubmitted", "sms*"]`. A wildcard character ''*'' may be used to match any number of characters in the `definitionId`. A list of all valid `definitionId`s can be obtained from the [Get list of event definitions](https://www.infobip.com/docs/api#customer-engagement/people/get-events-definitions-for-export) endpoint. The total number of matched `definitionId`s, after wildcard expansion, may not exceed 200. To export all events without filtering, do not specify a `definitionIdList`.'
          items:
            type: string
          maxItems: 200
          uniqueItems: true
          writeOnly: true
        enrichWithMomentsInfo:
          type: boolean
          description: If set to `true`, additional information, namely the campaign name, Flow's element name (if applicable), and the campaign start date and time are added to all existing events related to Moments. Defaults to `false`.
          writeOnly: true
      required:
      - bucket
      - endTime
      - region
      - roleArn
      - startTime
      title: ExportRequestBody
    6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagEntry:
      type: object
      properties:
        query:
          allOf:
          - $ref: '#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery'
      title: BatchTagEntry
    a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.StatusResponseBody:
      type: object
      properties:
        requestId:
          type: string
          description: Request ID of the data export request, the status of which is being queried on the [GET status](#customer-engagement/people/get-events-export-request-status) endpoint.
          readOnly: true
        status:
          $ref: '#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.RequestStatus'
        message:
          type: string
          description: Completion message of data export request, if applicable.
          readOnly: true
      required:
      - requestId
      - status
      title: StatusResponseBody
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError404:
      type: object
      properties:
        errorCode:
          type: string
          description: Error code uniquely identifying the error case.
          examples:
          - E404
          title: Errorcode
        description:
          type: string
          description: Detailed description of an error.
          examples:
          - The requested resource could not be found.
          title: Description
        action:
          type: string
          description: Action that should be taken to recover from the error.
          examples:
          - Please check the resource identifier and ensure it exists.
          title: Action
        violations:
          type: array
          description: List of violations that caused the error.
          examples:
          - []
          items:
            $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIErrorViolations'
          title: Violations
        resources:
          type: array
          description: List of available resources to recover from the error.
          examples:
          - []
          items:
            $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIErrorResources'
          title: Resources
      required:
      - action
      - description
      - errorCode
      - resources
      - violations
      title: APIError404
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalConfigApiModel:
      type: object
      example:
        tagName: external_number
        transferToAnyNumberEnabled: true
        createdAt: '2022-11-18T09:23:44.033Z'
        updatedAt: '2023-01-24T21:44:31.630Z'
      properties:
        tagName:
          type: string
          example: external_number
          maxLength: 256
          minLength: 0
          readOnly: true
        transferToAnyNumberEnabled:
          type: boolean
          default: true
          description: Enable or disable agents to transfer calls to numbers that are not stored in People
        createdAt:
          type: string
          example: 2022-12-10T13:45:00.777+0000
          readOnly: true
        updatedAt:
          type: string
          example: 2022-12-10T13:45:00.777+0000
          readOnly: true
      title: TransferToExternalConfigApiModel
    fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderDirection:
      type: string
      description: Sort direction for results.
      enum:
      - Asc
      - Desc
      title: DefinitionOrderDirection
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeType:
      type: string
      description: Type of the tree node.
      enum:
      - CATEGORY
      - FOLDER
      - ARTICLE
      example: FOLDER
      title: TreeNodeType
    fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventFieldType:
      type: string
      description: Field data type.
      enum:
      - String
      - Boolean
      - DateTime
      - Numeric
      - Decimal
      - List
      title: EventFieldType
    85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiRequestErrorDetails:
      type: object
      properties:
        messageId:
          type: string
          description: Identifier of the error.
          readOnly: false
          writeOnly: false
        text:
          type: string
          description: Detailed error description.
          readOnly: false
          writeOnly: false
      title: ApiRequestErrorDetails
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.WebhookPersonUniqueField:
      type: object
      description: Unique identifier of the participant.
      properties:
        identifier:
          type: string
          description: Unique ID for a person
        type:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.WebhookPersonUniqueFieldType'
        sender:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `PHONE`, `EMAIL`
      required:
      - identifier
      - type
      title: WebhookPersonUniqueField
    85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiRequestError:
      type: object
      properties:
        serviceException:
          allOf:
          - $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiRequestErrorDetails'
      title: ApiRequestError
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource:
      type: string
      description: External source of the node, if imported.
      enum:
      - CSV
      - SHAREPOINT
      - CONFLUENCE
      example: CONFLUENCE
      title: ContentSource
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateFileApiResponse:
      type: object
      description: List of template attachments.
      properties:
        id:
          type: string
        fileName:
          type: string
        fileExtension:
          type: string
        fileSize:
          type: integer
          format: int64
        contentType:
          type: string
        publicLink:
          type: string
        thumbLink:
          type: string
        uploadedAt:
          type: string
          format: date-time
      title: TemplateFileApiResponse
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormConditionalFieldRequest:
      type: object
      properties:
        fieldId:
          type: string
        isRequired:
          type: boolean
      required:
      - fieldId
      - isRequired
      title: FormConditionalFieldRequest
    fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.PersonUniqueFieldType:
      type: string
      enum:
      - ID
      - EXTERNAL_ID
      - PHONE
      - EMAIL
      - LINE
      - FACEBOOK
      - TELEGRAM
      - PUSH
      - WEB_PUSH
      - LIVE_CHAT
      - VIBER_BOTS
      - INSTAGRAM
      - INSTAGRAM_DM
      - TWITTER
      - APPLE_BUSINESS_CHAT
      - KAKAO_SANGDAM
      - GOOGLE_BUSINESS_MESSAGES
      - WHATSAPP
      - ZALO_FOLLOWER
      - TIKTOK_BM
      title: PersonUniqueFieldType
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.SearchCriteria:
      type: object
      properties:
        searchExp:
          type: string
          description: Search expression to filter results by.
          example: SMS API
        filter:
          type: object
          additionalProperties:
            type: string
            example: '{"status":"PUBLISHED"}'
          description: Key-value filter pairs for advanced search criteria.
          example:
            status: PUBLISHED
      title: SearchCriteria
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VideoFilterModeApiModel:
      type: string
      description: Background filter mode.
      enum:
      - NONE
      - BACKGROUND_BLUR
      - VIRTUAL_BACKGROUND
      - FACE_TRACK
      title: VideoFilterModeApiModel
    f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.ShareRequest:
      type: object
      example:
        accounts:
        - 7CB64E2791F1A14E5BFEBED41A70F08D
      properties:
        accounts:
          type: array
          description: List of sub account identifiers. Identifiers are account keys.
          items:
            type: string
            description: List of sub account identifiers. Identifiers are account keys.
      required:
      - accounts
      title: ShareRequest
    ApiErrorViolation:
      type: object
      description: List of violations that caused the error.
      properties:
        property:
          type: string
          description: Request property that caused the error.
        violation:
          type: string
          description: Detailed violation description.
      title: ApiErrorViolation
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse:
      type: object
      properties:
        statusCode:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCode'
        message:
          type: string
      title: StatusCodeResponse
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.EventClauseDto:
      type: object
      description: List of events that persons should match.
      properties:
        definitionId:
          type: string
          description: Event definition ID.
          example: addedToCart
        occurrenceCondition:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OccurrenceConditionDto'
        timelineCondition:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionDto'
        payloadConditions:
          type: array
          description: Specify the conditions of the event payload.
          items:
            $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PayloadConditionDto'
      required:
      - definitionId
      - timelineCondition
      title: EventClauseDto
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreStatsResponse:
      type: object
      properties:
        position:
          type: integer
          description: Position of the participant on the leaderboard, taking into account tie-breaking.
          title: Position
        rank:
          type: integer
          description: Position of the participant on the leaderboard, not taking into account tie-breaking.
          title: Rank
        tiedWith:
          type: integer
          description: Number of other participants tied with the same score.
          title: Tiedwith
        bestScore:
          type: integer
          description: The highest score achieved by the participant in the campaign.
          title: Bestscore
        attempts:
          type: integer
          description: Total number of attempts made by the participant in the campaign.
          title: Attempts
        attemptsRemaining:
          type: integer
          description: Number of attempts remaining for the participant today.
          title: Attemptsremaining
        nextScoreToBeat:
          type: integer
          description: The next highest score the participant needs to beat to improve their ranking.
          title: Nextscoretobeat
        numberOfParticipants:
          type: integer
          description: Total number of participants in the campaign.
          title: Numberofparticipants
      required:
      - attempts
      - attemptsRemaining
      title: ScoreStatsResponse
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Unit:
      type: string
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: Unit
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotApiModel:
      type: object
      example:
        displayName: My Whatsapp Bot
        webhookUrl: www.webhookurl.com/link1
        destination: '447492263897'
        channel: WHATSAPP
        messagePersistencePolicy: PERSIST_ALL
        enabled: true
        sessionTimeoutInSec: 120
      properties:
        id:
          type: string
          readOnly: true
        displayName:
          type: string
          description: Bot name to be displayed.
          maxLength: 255
          minLength: 0
        webhookUrl:
          type: string
          description: Webhook url the message will be forwarded to.
          maxLength: 2000
          minLength: 0
        destination:
          type: string
          description: Bot destination phone number, FB messenger Id or live chat widget Id.
          maxLength: 255
          minLength: 0
        enabled:
          type: boolean
          default: true
          description: Bot enable/disable toggle.
        messagePersistencePolicy:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessagePersistencePolicy'
        channel:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessageChannel'
        sessionTimeoutInSec:
          type: integer
          format: int64
          default: 86400
          description: 'Time elapsed from last client message, after which conversation will be closed.

            If not set, conversation will be closed after 24 hours.'
          maximum: 86400
          minimum: 60
        webhookHeaders:
          type: object
          additionalProperties:
            type: string
            deprecated: true
          deprecated: true
        webhookEventUrl:
          type: string
          description: Webhook url on which will be automatically forwarded all events.
          maxLength: 2000
          minLength: 0
        webhookEventHeaders:
          type: object
          additionalProperties:
            type: string
      required:
      - channel
      - destination
      - displayName
      title: BotApiModel
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse:
      type: object
      properties:
        statusCode:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCode'
        message:
          type: string
      title: StatusCodeResponse
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OutboundCallConversationResponseApiModel:
      type: object
      example:
        from: '385998779621'
        to: '38761123333'
        conversationId: 718A037A2FE0D2D5AA2D12A7240ED8C4
        agentId: 2010EA93ABC142E812C19F529BCBD22F
      properties:
        from:
          type: string
          description: DID number that is used to originate the call. DID numbers can be configured through the portal, or using the 'Purchase a number' endpoint.
        to:
          type: string
          description: Destination number.
        conversationId:
          type: string
          description: Id of the created conversation
          readOnly: true
        agentId:
          type: string
          description: Id of the agent originating the call.
      required:
      - agentId
      - from
      - to
      title: OutboundCallConversationResponseApiModel
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueApiModel:
      type: object
      example:
        name: Spanish Support
        isAutoAssignmentEnabled: false
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          description: Queue name.
          maxLength: 255
          minLength: 0
        enabledAgentsCount:
          type: integer
          format: int32
        enabledRoutesCount:
          type: integer
          format: int32
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
        isAutoAssignmentEnabled:
          type: boolean
          default: false
          description: Queue Auto-assignment toggle.
        autoAssignmentAlgorithm:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AutoAssignmentAlgorithm'
        isAutoAssignmentOutsideOfWorkingHoursEnabled:
          type: boolean
          default: false
          description: Queue Auto-assignment Outside of Working hours toggle
        stickyAgentTimeoutDays:
          type: integer
          format: int64
          description: Number of days since last interaction with the customer.
        isStickyAutoAssignmentEnabled:
          type: boolean
          description: Auto-assignment according to last interaction with the customer.
        workingHoursId:
          type: string
          description: Working hours Id queue belongs to
        isRestricted:
          type: boolean
          default: false
          description: Is queue restricted.
        isPrivate:
          type: boolean
          default: false
          description: Is queue private.
        deletedAt:
          type: string
          format: date-time
        externalId:
          type: string
      title: QueueApiModel
    b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonPushContact:
      type: object
      properties:
        additionalData:
          type: object
          additionalProperties:
            type: object
          description: Additional data collected from the user's profile
          readOnly: true
          writeOnly: false
        applicationId:
          type: string
          description: Application Id on which the user is subscribed.
          readOnly: true
          writeOnly: false
        registrationId:
          type: string
          description: Push registration ID.
          readOnly: true
          writeOnly: false
        systemData:
          type: object
          additionalProperties:
            type: object
          description: System data collected from the user's profile
          readOnly: true
          writeOnly: false
      title: CommonPushContact
    4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CategoryItemResponse:
      type: object
      description: The list of the results for this page.
      properties:
        name:
          type: string
          description: Name of the category.
          example: API Guides
        id:
          type: string
          format: uuid
          description: Unique identifier of the category.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        visibility:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility'
      required:
      - id
      - name
      - visibility
      title: CategoryItemResponse
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsItemResponse:
      type: object
      description: ''
      properties:
        property:
          type: string
          description: The name of the specific property or field related to the error.
        message:
          type: string
          description: A descriptive message explaining the nature of the error associated with the property.
      required:
      - message
      - property
      title: ErrorDetailsItemResponse
    ApiError:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code uniquely identifying the error case.
        description:
          type: string
          description: A detailed description of an error.
        action:
          type: string
          description: An action that should be taken to recover from the error.
        violations:
          type: array
          description: List of violations that caused the error.
          items:
            $ref: '#/components/schemas/ApiErrorViolation'
        resources:
          type: array
          description: List of available resources to recover from the error.
          items:
            $ref: '#/components/schemas/ApiErrorResource'
      required:
      - action
      - description
      - errorCode
      - resources
      - violations
      title: ApiError
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse:
      type: object
      example:
        id: 7646c2ff-916d-46f1-9c53-5273476ed505
        name: Test WebForm
        channel: EMAIL
        destination: destination@email.test
        url: /ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post
        enabled: true
        createdAt: '2023-11-01T00:00:00.000+00:00'
        updatedAt: '2023-11-01T00:00:00.000+00:00'
        tagIds:
        - 2423d4c7-23da-422a-9f15-ca08006051ea
        - 2664c7c3-f546-4073-a961-b94aed465ee8
      properties:
        id:
          type: string
          description: Web Form Id.
        name:
          type: string
          description: Web Form name.
        channel:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationChannel'
        destination:
          type: string
          description: Web Form destination.
        url:
          type: string
          description: Web Form URL.
        enabled:
          type: boolean
          description: Web Form enable/disable toggle.
        tagIds:
          type: array
          description: List of tag Ids used on the Web Form.
          items:
            type: string
            description: List of tag Ids used on the Web Form.
        createdAt:
          type: string
          format: date-time
          description: Time stamp when Web Form is created.
        updatedAt:
          type: string
          format: date-time
          description: Time stamp when Web Form was updated.
      title: WebFormApiResponse
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPurposeApiModel:
      type: string
      description: Purpose for which placeholders will be used in text-to-speech.
      enum:
      - WAITING_STRATEGY_GREETING_MESSAGE
      - WAITING_STRATEGY_ANNOUNCEMENT_MESSAGE
      - WAITING_STRATEGY_MAXIMUM_WAIT_TIME_MESSAGE
      - WORKING_HOURS_AWAY_MESSAGE
      - TRANSFER_STRATEGY_MESSAGE
      - ON_HOLD_MESSAGE
      - CALLBACK_CONFIRMATION_MESSAGE
      - WAITING_STRATEGY_GREETING_MESSAGE
      - WAITING_STRATEGY_ANNOUNCEMENT_MESSAGE
      - WAITING_STRATEGY_MAXIMUM_WAIT_TIME_MESSAGE
      - WORKING_HOURS_AWAY_MESSAGE
      - TRANSFER_STRATEGY_MESSAGE
      - ON_HOLD_MESSAGE
      - CALLBACK_CONFIRMATION_MESSAGE
      title: TtsPurposeApiModel
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CatalogRecordListItemResponse:
      type: object
      description: The list of the results for this page.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the article or attachment.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        name:
          type: string
          description: Name of the article or attachment.
          example: Getting Started with SMS API
        description:
          type: string
          description: Description or content excerpt of the article or attachment.
          example: This guide covers the basics of sending SMS messages via the Infobip API.
        tags:
          type: array
          description: Tags assigned to the record.
          example:
          - sms
          - api
          items:
            type: string
            description: Tags assigned to the record.
            example: '["sms","api"]'
          uniqueItems: true
        type:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.InternalType'
        scope:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope'
        url:
          type: string
          description: URL for external content to open or download.
          example: https://example.com/document.pdf
        sizeInBytes:
          type: integer
          format: int64
          description: Size of attachment in bytes. Present only for attachments.
          example: 1048576
        contentType:
          type: string
          description: MIME type of attachment. Present only for attachments.
          example: application/pdf
        contentSource:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource'
        visibility:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility'
      required:
      - id
      - name
      - scope
      - tags
      - type
      title: CatalogRecordListItemResponse
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse:
      type: object
      properties:
        Status:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Status'
        message:
          type: string
      title: StatusResponse
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponseResultPage:
      type: object
      example:
        agents:
        - id: 9030551F327704A0F262995A1A4B4596
          displayName: Malcolm Young
          status: INVISIBLE
          availability: AWAY
          role: AGENT
          enabled: true
          createdAt: 2019-05-10T07:45:23.777+0000
          updatedAt: 2019-05-10T09:53:58.463+0000
        - id: 97457D13B1FC79AF3C1A1096AE7E77AB
          displayName: Angus Young
          status: ACTIVE
          availability: BUSY
          role: SUPERVISOR
          enabled: true
          createdAt: 2019-05-10T07:45:23.777+0000
          updatedAt: 2019-05-10T09:53:58.463+0000
        - id: E83E787CF2613450157ADA3476171E3F
          displayName: Bon Scott
          status: INVISIBLE
          availability: BUSY
          role: AGENT
          enabled: true
          createdAt: 2019-05-10T07:45:23.777+0000
          updatedAt: 2019-05-10T09:53:58.463+0000
        - id: F66D67327326FCCB027BEAA916B94542
          displayName: Phil Rudd
          status: ACTIVE
          availability: ACTIVE
          role: AGENT
          enabled: true
          createdAt: 2019-05-10T07:45:23.777+0000
          updatedAt: 2019-05-10T09:53:58.463+0000
        - id: F66D67327326FCCB027BEAA916B94542
          displayName: Brian Johnson
          status: ACTIVE
          availability: BUSY
          role: AGENT
          enabled: true
          createdAt: 2019-05-10T07:45:23.777+0000
          updatedAt: 2019-05-10T09:53:58.463+0000
        - id: 7E77AB97457D13B1FC79AF3C1A1096AE7E77AB
          displayName: Neil Young
          status: ACTIVE
          availability: ACTIVE
          role: AGENT
          enabled: false
          createdAt: 2019-03-10T07:45:44.744+0000
          updatedAt: 2019-03-10T09:33:58.374+0000
        pagination:
          totalItems: 6
          page: 0
          limit: 10
          orderBy: id:ASC
      properties:
        agents:
          type: array
          items:
            $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse'
        pagination:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Pagination'
      title: AgentResponseResultPage
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentRefResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the comment.
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
      required:
      - id
      title: CommentRefResponse
    62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse:
      type: object
      properties:
        results:
          type: array
          description: List of any unsuccessful result from the batch operation for each processed entry. Example, name used in the request already exists.
          items:
            $ref: '#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResult'
          readOnly: false
          writeOnly: false
      title: BatchDeleteResponse
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AutoAssignmentAlgorithm:
      type: string
      default: LOAD_BALANCING
      description: Queue Auto-assignment algorithm.
      enum:
      - LOAD_BALANCING
      - ROUND_ROBIN
      - PERFORMANCE_BASED
      - LOAD_BALANCING
      - ROUND_ROBIN
      - PERFORMANCE_BASED
      title: AutoAssignmentAlgorithm
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationChannel:
      type: string
      description: Communication channel.
      enum:
      - SMS
      - VIBER
      - FACEBOOK_MESSENGER
      - WHATSAPP
      - RCS
      - UNKNOWN
      - EMAIL
      - MULTICHANNEL
      - NO_CHANNEL
      - LIVE_CHAT
      - UNUSED
      - VOICE
      - VIDEO
      - APPLE_BUSINESS_CHAT
      - LINE
      - GOOGLE_BUSINESS_MESSAGES
      - TELEGRAM
      - CALLS
      - INTERNAL
      - FACEBOOK_POST
      - INSTAGRAM_POST
      - TWITTER_POST
      - VIBER_BOT
      - INSTAGRAM_MESSAGING
      - GOOGLE_PLAY
      - KAKAO_SANGDAM
      - TWITTER_DM
      - WHATSAPP_CALLS
      - VIBER_CALLS
      - OPEN_CHANNEL
      - TIKTOK
      - ZALO
      title: ConversationChannel
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.STTModelProvider:
      type: string
      description: Speech-to-text model provider options.
      enum:
      - AZURE
      - GOOGLE
      title: STTModelProvider
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormSubmissionApiRequest:
      type: object
      example:
        from: from.testmail@email.test
        subject: Test Subject
        cc:
        - cc1@email.test
        - cc2@email.test
        content: Example text file.
        attachmentIds:
        - dd68c1ec-1997-4e90-add6-b36dfd2b80a3
      properties:
        from:
          type: string
          description: Sender of the submission.
        subject:
          type: string
          description: Submission subject.
        cc:
          type: array
          description: List of web form submission carbon copy recipients.
          items:
            type: string
            description: List of web form submission carbon copy recipients.
        content:
          type: string
          description: Web form submission body content.
        attachmentIds:
          type: array
          description: Web form submission attachment Ids.
          items:
            type: string
            description: Web form submission attachment Ids.
      required:
      - content
      - from
      title: WebFormSubmissionApiRequest
    85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException:
      type: object
      properties:
        requestError:
          allOf:
          - $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiRequestError'
      title: ApiException
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventChannel:
      type: string
      description: Channel where the event will be sent.
      enum:
      - LIVE_CHAT
      - APPLE_BUSINESS_CHAT
      - WHATSAPP
      title: ConversationEventChannel
    25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCode:
      type: string
      enum:
      - SUCCESS
      - ERROR
      title: StatusCode
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AssignAgentApiRequest:
      type: object
      example:
        agentId: c856e230-a8cd-498b-9996-42bbed35029a
      properties:
        agentId:
          type: string
          description: Id of the conversation assignee.
          maxLength: 255
          minLength: 0
      required:
      - agentId
      title: AssignAgentApiRequest
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreReturn:
      type: object
      properties:
        campaignId:
          type: string
          format: uuid
          description: Unique identifier of the campaign the score belongs to.
          title: Campaignid
        userId:
          type: string
          description: User ID, usually in the format of a phone number, e.g., 00387123456.
          examples:
          - 00387123456
          title: Userid
        name:
          type: string
          description: Name of the participant e.g. John Smith. Maximum 300 characters long. Cannot be empty or whitespace.
          title: Name
        audioUrl:
          type: string
          description: URL of the audio file used for sound matching. Must be a valid URL pointing to an audio file.
          examples:
          - https://www.example.com/audio/test.wav
          title: Audiourl
        languageCode:
          type: string
          description: Language code of the audio file, e.g., 'en-US' for English. This should match the language of the audio file being submitted.
          examples:
          - en-US
          title: Languagecode
        channel:
          $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.Channel'
          default: UNKNOWN
        keywordScore:
          type: number
          description: Score for keyword matching, ranging from 0 to 1, where 1 is a perfect match.
          title: Keywordscore
        shapeScore:
          type: number
          description: Score for shape matching, ranging from 0 to 1, where 1 is a perfect match.
          title: Shapescore
        finalScore:
          type: integer
          description: Final calculated score for this attempt, ranging from 0 to 1000.
          title: Finalscore
        transcribedAudio:
          type: string
          description: Text transcription of the submitted audio file.
          title: Transcribedaudio
        attempts:
          type: integer
          default: 1
          description: Number of attempts made by the participant in the campaign.
          title: Attempts
        dateModified:
          type: string
          format: date-time
          description: Date and time when this score was last modified, in UTC.
          title: Datemodified
        bestScore:
          type: integer
          description: The highest score achieved by the participant in the campaign.
          title: Bestscore
      required:
      - audioUrl
      - bestScore
      - campaignId
      - finalScore
      - languageCode
      - userId
      title: ScoreReturn
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel:
      type: object
      example:
        inbound: true
        outbound: true
        autoCompose: false
        mediaType: AUDIO_AND_VIDEO
        videoDownloadPreparation: false
        enabled: true
        enabledChangedAt: 1622024333000
      properties:
        inbound:
          type: boolean
          description: 'Enables inbound call recording. At least one of the parameters ''inbound'' or ''outbound'' must be set to true. '
        outbound:
          type: boolean
          description: 'Enables outbound call recording. At least one of the parameters ''inbound'' or ''outbound'' must be set to true. '
        autoCompose:
          type: boolean
          default: false
          description: Enables composition of call recordings. If set to true, the call recording will be merged into a single audio or video file.
        mediaType:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.MediaTypeApiModel'
        enabled:
          type: boolean
          default: false
        enabledChangedAt:
          type: integer
          format: int64
          readOnly: true
      required:
      - mediaType
      title: AccountRecordingConfigApiModel
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: A unique segment identifier.
          example: 42
        name:
          type: string
          description: A unique segment name.
          example: VIP Alex Clients
        description:
          type: string
          description: Segment description.
          example: Persons named Alex with tag "VIP Client"
        query:
          type: object
          additionalProperties:
            type: object
            example:
              '#and':
              - firstName: Alex
              - '#contains':
                  tags: VIP Client
          description: "\nAllows to filter persons using simple queries.\n\n##### Supported logical operators\n\n<table>\n    <thead>\n        <tr>\n            <th>Operator</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#and</code></td>\n        <td>All records that match the conditions of all clauses.</td>\n        <td><code>{\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]}</code></td>\n    </tr>\n    <tr>\n        <td><code>#or</code></td>\n        <td>All records that match the conditions of any clause.</td>\n        <td><code>{\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]}</code></td>\n    </tr>\n</table>\n\n##### Supported comparison operators\n\n<table>\n    <thead>\n        <tr>\n            <th>Attributes</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#notExist</code></td>\n        <td>Matches records that do not have given attribute.</td>\n        <td><code>{\"#notExist\":\"firstName\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#exist</code></td>\n        <td>Matches records that have given attribute.</td>\n        <td><code>{\"#exists\":\"firstName\"}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Strings</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified string.</td>\n        <td><code>{\"firstName\":\"John\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified string.</td>\n        <td><code>{\"#ne\":{\"firstName\":\"John\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#startsWith</code></td>\n        <td>Starts with a specified string.</td>\n        <td><code>{\"#startsWith\":{\"firstName\":\"John\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#endsWith</code></td>\n        <td>Ends with a specified string.</td>\n        <td><code>{\"#endsWith\":{\"firstName\":\"John\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#contains</code></td>\n        <td>Contains a specified string.</td>\n        <td><code>{\"#contains\":{\"firstName\":\"oh\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notContain</code></td>\n        <td>Does not contain a specified string.</td>\n        <td><code>{\"#notContain\":{\"firstName\":\"oh\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>At least one of the strings in a list.</td>\n        <td><code>{\"#in\":{\"firstName\":[\"John\",\"Jane\"]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Not any of the strings in a list.</td>\n        <td><code>{\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Dates</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified date.</td>\n        <td><code>{\"birthDate\":\"1987-07-10\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified date.</td>\n        <td><code>{\"#ne\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#eq (relative)</code></td>\n        <td>Will be in specified interval.</td>\n        <td><code>{\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt (relative)</code></td>\n        <td>Will be within a specified interval.</td>\n        <td><code>{\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt (relative)</code></td>\n        <td>Will be in more than a specified interval.</td>\n        <td><code>{\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#eq (relative) -</code></td>\n        <td>Was a specified interval ago.</td>\n        <td><code>{\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt (relative) -</code></td>\n        <td>Was within a specified interval ago.</td>\n        <td><code>{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt (relative) -</code></td>\n        <td>Was more than a specified interval ago.</td>\n        <td><code>{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt</code></td>\n        <td>Is before a specified date.</td>\n        <td><code>{\"#lt\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lte</code></td>\n        <td>Is before or equal to a specified date.</td>\n        <td><code>{\"#lte\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt</code></td>\n        <td>Is after a specified date.</td>\n        <td><code>{\"#gt\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gte</code></td>\n        <td>Is after or equal to a specified date.</td>\n        <td><code>{\"#gte\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>Is equal to one of dates in a given list.</td>\n        <td><code>{\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Is not equal to any of dates in a given list.</td>\n        <td><code>{\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Integers</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified integer.</td>\n        <td><code>{\"data\\u0001counter\":1}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified integer.</td>\n        <td><code>{\"#ne\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt</code></td>\n        <td>Is less than a specified integer.</td>\n        <td><code>{\"#lt\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lte</code></td>\n        <td>Is less than or equal to a specified integer.</td>\n        <td><code>{\"#lte\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt</code></td>\n        <td>Is greater than a specified integer.</td>\n        <td><code>{\"#gt\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gte</code></td>\n        <td>Is greater than or equal to a specified integer.</td>\n        <td><code>{\"#gte\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>Is equal to any of specified integers in a list.</td>\n        <td><code>{\"#in\":{\"data\\u0001counter\":[1,2,3]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Is not equal to any of specified integers in a list.</td>\n        <td><code>{\"#notIn\":{\"data\\u0001counter\":[1,2,3]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Decimals</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified decimal.</td>\n        <td><code>{\"data\\u0001price\":1.1}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Is not equal to a specified decimal.</td>\n        <td><code>{\"#ne\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt</code></td>\n        <td>Is less than a specified decimal.</td>\n        <td><code>{\"#lt\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lte</code></td>\n        <td>Is less than or equal to a specified decimal.</td>\n        <td><code>{\"#lte\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt</code></td>\n        <td>Is greater than a specified decimal.</td>\n        <td><code>{\"#gt\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gte</code></td>\n        <td>Is greater than or equal to a specified decimal.</td>\n        <td><code>{\"#gte\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>Is equal to any of specified decimals in a list.</td>\n        <td><code>{\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Is not equal to any of specified decimals in a list.</td>\n        <td><code>{\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Booleans</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified boolean.</td>\n        <td><code>{\"data\\u0001happy\":true}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified boolean.</td>\n        <td><code>{\"#ne\":{\"data\\u0001happy\":true}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Tags</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#contains</code></td>\n        <td>Contains a specified tag.</td>\n        <td><code>{\"#contains\":{\"tags\":\"SOME_TAG\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notContain</code></td>\n        <td>Does not contain a specified tag.</td>\n        <td><code>{\"#notContain\":{\"tags\":\"SOME_TAG\"}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Gender</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals a specified gender.</td>\n        <td><code>{\"gender\":\"MALE\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Does not equal a specified gender.</td>\n        <td><code>{\"#ne\":{\"gender\":\"FEMALE\"}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Lists</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#all</code></td>\n        <td>All items in the list match.</td>\n        <td><code>{\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}</code>\n        </td>\n    </tr>\n    <tr>\n        <td><code>#any</code></td>\n        <td>Any item in the list match.</td>\n        <td><code>{\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}</code>\n        </td>\n    </tr>\n</table>\n\n"
          example:
            '#and':
            - firstName: Alex
            - '#contains':
                tags: VIP Client
        events:
          type: array
          description: List of events that persons should match.
          items:
            $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.EventClauseDto'
        createdAt:
          type: string
          format: date-time
          description: 'Date and time of creation. Has the following format: <code>yyyy-MM-dd''T''HH:mm:ss.SSSZ</code>.'
        modifiedAt:
          type: string
          format: date-time
          description: 'Date and time of last modification. Has the following format: <code>yyyy-MM-dd''T''HH:mm:ss.SSSZ</code>.'
      required:
      - id
      - name
      title: SegmentResponseDto
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel:
      type: object
      example:
        id: 63a99eb0b8863d4d26678000
        name: Hold Config Name
        onHoldMusic:
          enabled: true
          useDefault: false
          fileAudioSource:
            fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1124
        announcementMessage:
          audioSourceType: TTS
          ttsAudioSource:
            text: Hello this a text to speech message
            language: English
            voice:
              name: Test
              gender: FEMALE
            speechRate: 1.0
            fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb1125
          fileAudioSource:
            fileDescriptor: eea6b505-6e67-420a-b1a2-2307fafb116
          duration:
            unit:
            - SECONDS
            - MINUTES
            - HOURS
            value: 2
        default: false
        enabled: true
        queueIds:
        - FD80A6AA8E0DB8A5165276570943D8CF
        - A4BBE5D92667EEAB69860D457E877A59
        createdAt: 2022-12-10T13:45:00.777+0000
        updatedAt: 2022-12-10T13:45:00.777+0000
      properties:
        id:
          type: string
          description: Unique id of the hold configuration.
          readOnly: true
        name:
          type: string
          description: Hold configuration name.
          maxLength: 128
          minLength: 1
        onHoldMusic:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceWithDefaultOptionApiModel'
        announcementMessage:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileOrTtsAudioSourceWithRepeatIntervalApiModel'
        createdAt:
          type: string
          example: 2022-12-10T13:45:00.777+0000
          readOnly: true
        updatedAt:
          type: string
          example: 2022-12-10T13:45:00.777+0000
          readOnly: true
        queueIds:
          type: array
          description: Specifies which queues is the given hold config applied to. Empty list is supported for default config.
          items:
            type: string
            description: Specifies which queues is the given hold config applied to. Empty list is supported for default config.
        enabled:
          type: boolean
        default:
          type: boolean
      required:
      - name
      - queueIds
      title: HoldConfigWithQueuesApiModel
    25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiRequest:
      type: object
      example:
        timezone: Etc/UTC
        message: We're out of office, come back another time, thank you!
        workWeek:
          MONDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          TUESDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          WEDNESDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          THURSDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          FRIDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          SATURDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          SUNDAY:
            startTime: 0
            endTime: 1440
            enabled: true
        name: My Working Hours
        enabled: true
        isDefault: true
        closeConversations: false
        holidays:
        - name: New Year's Day
          startDate: '2021-01-01'
          endDate: '2021-01-01'
          enabled: true
        - name: My Holiday
          startDate: '2021-06-09'
          endDate: '2021-06-09'
          enabled: false
      properties:
        id:
          type: string
          description: Working hours Id.
          readOnly: true
        timezone:
          type: string
          description: 'Timezone in which working hours apply.

            `TZ database name` from [IANA time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)'
        message:
          type: string
          description: Message to be sent as an auto-reply message to the customer.
          maxLength: 4000
          minLength: 0
        workWeek:
          $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.DailyWorkingHoursApiModel'
        name:
          type: string
          description: Working hours name.
          maxLength: 255
          minLength: 0
        enabled:
          type: boolean
          description: Working hours enable/disable toggle.
        isDefault:
          type: boolean
          description: Default working hours.
        closeConversations:
          type: boolean
          description: Close conversation created outside of working hours toggle.
        sendAwayMessageEveryOOWHPeriod:
          type: boolean
        holidays:
          type: array
          description: List of working hours holidays.
          items:
            $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.HolidaysApiModel'
          uniqueItems: true
      required:
      - message
      - name
      - timezone
      - workWeek
      title: WorkingHoursApiRequest
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormResultPage:
      type: object
      example:
        items:
        - id: 75f57446-1d65-478a-87ed-22d17dc3d077
          title: Granulation
          isEnabled: true
          isDefault: false
          fields: null
          createdAt: '2021-03-29T14:04:48.468346Z'
          updatedAt: '2021-03-29T14:04:48.468349Z'
        - id: 269757a0-38a6-4226-a8db-cc27930f6a2f
          title: Demo form
          isEnabled: false
          isDefault: false
          fields: null
          createdAt: '2021-04-17T07:54:44.401772Z'
          updatedAt: '2021-04-17T07:54:44.401773Z'
        pagination:
          totalItems: 2
          page: 0
          limit: 10
          orderBy:
            property: id
            direction: ASC
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form'
        pagination:
          $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Pagination'
      title: FormResultPage
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldConditionRequest:
      type: object
      properties:
        id:
          type: string
        value:
          type: string
        conditionalFields:
          type: array
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormConditionalFieldRequest'
          maxItems: 2147483647
          minItems: 1
      required:
      - conditionalFields
      - value
      title: FieldConditionRequest
    fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest:
      type: object
      properties:
        eventId:
          type:
          - string
          - 'null'
          description: Unique identifier of the event. If provided, it helps prevent duplicate events in case of retries—for example, if the first API call fails and the same event is sent again. Passing the same `eventId` ensures the event is only recorded once in the person profile.<br>The value must be `1–36` characters long and can include letters `(A–Z, a–z)`, digits `(0–9)`, underscores `(_)`, and hyphens `(-)` only.
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            type: object
          description: Object containing event properties. Must match the corresponding event definition. See People Events [documentation](https://www.infobip.com/docs/people/events#properties-custom-events) for supported data types.
      title: EventResourceRequest
    f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.CompanyIdentityQuery:
      type: object
      properties:
        id:
          type: string
          description: Company ID
          readOnly: false
          writeOnly: false
        externalId:
          type: string
          description: Company external ID
          readOnly: false
          writeOnly: false
        name:
          type: string
          description: Company name
          readOnly: false
          writeOnly: false
        domain:
          type: string
          description: Company domain
          readOnly: false
          writeOnly: false
      title: CompanyIdentityQuery
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRequest:
      type: object
      example:
        displayName: Angus Young
        status: ACTIVE
        role: SUPERVISOR
        enabled: true
      properties:
        displayName:
          type: string
          description: Agent name to be displayed.
          maxLength: 255
          minLength: 0
        status:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup'
        role:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRole'
        enabled:
          type: boolean
          default: true
          description: Agent enabled/disabled toggle.
      required:
      - displayName
      - role
      - status
      title: AgentRequest
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldType:
      type: string
      description: Field type.
      enum:
      - TEXT
      - MULTILINE
      - CHECKBOX
      - DROPDOWN
      - INTNUMBER
      - DECIMALNUMBER
      - REGEX
      - DATE
      - CARD
      title: FieldType
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsAudioSourceApiModel:
      type: object
      description: Text-to-speech audio source information.
      properties:
        text:
          type: string
          description: 'Text to convert using text-to-speech. This field supports usage of placeholders. Use the following endpoint to find which placeholders are supported: <a href="https://www.infobip.com/docs/api/customer-engagement/conversations/get-conversations-tts-supported-placeholders" target="_blank">Get supported TTS placeholders for purpose</a>. Placeholders are used to dynamically insert values into the text. For example, you can use placeholders to insert the customer''s position in queue as part of announcement message in waiting strategy.'
          maxLength: 1400
          minLength: 0
        language:
          type: string
          description: 'If the message is in text format, the language in which the message is written must be defined for correct pronunciation. In the Languages section, you can find the list of languages that we support: <a href="https://www.infobip.com/docs/voice-and-video/outbound-calls#text-to-speech-voice-over-broadcast" target="_blank">Voice Text-To-Speech Languages.</a>'
          maxLength: 36
          minLength: 1
        isLanguageSelectedManually:
          type: boolean
          description: This option controls whether automatic language detection will be performed on provided text.
        voice:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VoiceApiModel'
        speechRate:
          type: number
          format: double
          description: Text-to-speech speech rate.
          maximum: 2
          minimum: 0.5
      required:
      - language
      - speechRate
      - text
      - voice
      title: TtsAudioSourceApiModel
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileOrTtsAudioSourceWithRepeatIntervalApiModel:
      type: object
      description: File audio source or TTS audio source information with repeat interval.
      properties:
        enabled:
          type: boolean
        Audio source type:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AudioSourceTypeApiModel'
        ttsAudioSource:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsAudioSourceApiModel'
        fileAudioSource:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel'
        repeatInterval:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel'
      title: FileOrTtsAudioSourceWithRepeatIntervalApiModel
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.InternalType:
      type: string
      description: Type of the record.
      enum:
      - ARTICLE
      - ATTACHMENT
      example: ARTICLE
      title: InternalType
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCode:
      type: string
      enum:
      - SUCCESS
      - ERROR
      title: StatusCode
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Action:
      type: string
      description: Action type connected to the collectable.
      enum:
      - CALLBACK
      - RETURN_TO_IVR
      title: Action
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.CloudType:
      type: string
      description: Push registration id of the instance
      enum:
      - GCM
      - APNS
      - HMS
      - WEB
      readOnly: true
      title: CloudType
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateUpdateArticleRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of the article.
          example: Getting Started with SMS API
          maxLength: 255
          minLength: 3
        content:
          type: string
          description: Content of the article in HTML format.
          example: <h1>Introduction</h1><p>This guide covers the basics of the SMS API.</p>
        status:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus'
        tags:
          type: array
          description: List of tag names to assign to the article.
          example:
          - sms
          - api
          - getting-started
          items:
            type: string
            description: List of tag names to assign to the article.
            example: '["sms","api","getting-started"]'
        links:
          type: array
          description: List of attachment identifiers to link to the article.
          example:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
          items:
            type: string
            format: uuid
            description: List of attachment identifiers to link to the article.
        categoryId:
          type: string
          format: uuid
          description: Category identifier to assign the article to.
          example: a1b2c3d4-5678-9012-abcd-ef1234567890
        folderId:
          type: string
          format: uuid
          description: Folder identifier within the category.
          example: b2c3d4e5-6789-0123-bcde-f12345678901
      required:
      - categoryId
      - content
      - links
      - name
      - status
      - tags
      title: CreateUpdateArticleRequest
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ByUniqueRequestParameters:
      type: object
      description: List of identities.
      properties:
        type:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
        identifier:
          type: string
          description: Person ID. ID type must match the `type` parameter.
        sender:
          type: string
          description: Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
      required:
      - identifier
      - type
      title: ByUniqueRequestParameters
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.WebhookPersonUniqueFieldType:
      type: string
      description: Type of unique ID
      enum:
      - EMAIL
      - PHONE
      - FACEBOOK
      - LINE
      - APPLE_BUSINESS_CHAT
      title: WebhookPersonUniqueFieldType
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.Campaign:
      type: object
      properties:
        name:
          type: string
          description: Name of the campaign. Must be unique per account.
          examples:
          - My Campaign
          title: Name
        keywordSpec:
          type: object
          additionalProperties:
            type: string
          description: 'Specification of language-specific key phrases that users should pronounce during the campaign. This is a dictionary mapping language codes (ISO 639-1 with optional country code, e.g., ''en-US'', ''es-ES'') to the exact phrases users must say. Find the list of languages supported by Azure <a href="https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt">here</a> and the list of languages supported by Google <a href="https://cloud.google.com/speech-to-text/docs/speech-to-text-supported-languages">here</a>. The speech-to-text engine will compare user audio against these phrases for scoring. If left unspecified, the campaign will rely solely on image and/or audio matching. Phrases should be clear, pronounceable words or short sentences in the target language. '
          examples:
          - en-US: Hello
            es-ES: Hola
          title: Keywordspec
        activeFrom:
          type: string
          format: date-time
          description: Date and time when the campaign becomes active, in ISO 8601 format (e.g., 2023-10-01T00:00:00Z).
          title: Activefrom
        activeUntil:
          type: string
          format: date-time
          description: Date and time when the campaign ends, in ISO 8601 format (e.g., 2023-10-31T23:59:59Z).
          title: Activeuntil
        settings:
          $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignSettings'
          default:
            maxDailyAttemptsPerUser: 30
            sttModelProvider: AZURE
            maxDailyAttemptsPerCampaign: 1500
          description: Campaign settings. You can regulate the number of attempts per user daily, as well as the total number of attempts in the campaign daily.
        imageUrl:
          type: string
          description: Image used for shape matching.
          examples:
          - https://www.example.com/image.jpg
          title: Imageurl
        id:
          type: string
          format: uuid
          description: Unique identifier of the campaign.
          title: Id
        accountId:
          type: string
          description: ID of the account that owns the campaign.
          title: Accountid
        dateCreated:
          type: string
          format: date-time
          description: Date and time when the campaign was created, in ISO 8601 format (e.g., 2023-10-01T00:00:00Z).
          title: Datecreated
      required:
      - accountId
      - activeFrom
      - activeUntil
      - id
      - name
      title: Campaign
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse:
      type: object
      example:
        id: 97457D13B1FC79AF3C1A1096AE7E77AB
        displayName: Angus Young
        status: ACTIVE
        availability: BUSY
        role: SUPERVISOR
        enabled: true
        createdAt: 2019-05-10T09:53:58.463+0000
        updatedAt: 2019-05-10T09:53:58.463+0000
      properties:
        id:
          type: string
          description: Agent ID.
          readOnly: true
        displayName:
          type: string
          description: Agent name to be displayed.
          maxLength: 255
          minLength: 0
        title:
          type: string
        status:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup'
        availability:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup'
        role:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRole'
        enabled:
          type: boolean
          default: true
          description: Agent enabled/disabled toggle.
        createdAt:
          type: string
          format: date-time
          description: Time stamp when agent is created.
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          description: Time stamp when agent is last updated.
          readOnly: true
      required:
      - displayName
      title: AgentResponse
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertRequestDocsSchema:
      type: object
      properties:
        persons:
          type: array
          items:
            $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertPersonV3DocsSchema'
          maxItems: 1000
          minItems: 1
      title: UpsertRequestDocsSchema
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.Position:
      type: string
      description: Position relative to the target node.
      enum:
      - ABOVE
      - BELOW
      - APPEND
      example: BELOW
      title: Position
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteType:
      type: string
      enum:
      - INTERNAL
      - AUTH_BIOMETRY_INIT
      - AUTH_BIOMETRY_PENDING
      - AUTH_BIOMETRY_SUCCESS
      - AUTH_BIOMETRY_EXPIRED
      - AUTH_BIOMETRY_CANCEL
      - AUTH_BIOMETRY_FAILED
      - AUTH_AGENT_SUCCESS
      - AUTH_AGENT_EXPIRED
      - AUTH_BOT_SUCCESS
      - AUTH_BOT_EXPIRED
      - JIRA_COMMENT
      - ATTACHMENT
      - INTERNAL
      - ATTACHMENT
      title: NoteType
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithPeriodicCollectApiModel:
      type: object
      properties:
        enabled:
          type: boolean
        Audio source type:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AudioSourceTypeApiModel'
        ttsAudioSource:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsAudioSourceApiModel'
        fileAudioSource:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel'
        repeatInterval:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel'
        collectables:
          type: array
          items:
            $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CollectableApiModel'
        collectDuration:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel'
      title: OptionWithPeriodicCollectApiModel
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageChannel:
      type: string
      description: Available communication channels
      enum:
      - SMS
      - VIBER
      - FACEBOOK_MESSENGER
      - WHATSAPP
      - RCS
      - UNKNOWN
      - EMAIL
      - LIVE_CHAT
      - UNUSED
      - VOICE
      - VIDEO
      - APPLE_BUSINESS_CHAT
      - LINE
      - GOOGLE_BUSINESS_MESSAGES
      - TELEGRAM
      - CALLS
      - INTERNAL
      - VIBER_BOT
      - FACEBOOK_POST
      - INSTAGRAM_POST
      - TWITTER_POST
      - INSTAGRAM_MESSAGING
      - GOOGLE_PLAY
      - KAKAO_SANGDAM
      - TWITTER_DM
      - WHATSAPP_CALLS
      - VIBER_CALLS
      - OPEN_CHANNEL
      - TIKTOK
      - ZALO
      - SMS
      - VIBER
      - FACEBOOK_MESSENGER
      - WHATSAPP
      - RCS
      - LIVE_CHAT
      - LINE
      - APPLE_BUSINESS_CHAT
      - TELEGRAM
      - INSTAGRAM_MESSAGING
      - KAKAO_SANGDAM
      - VIBER_BOT
      - EMAIL
      title: MessageChannel
    a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamIntegrationsV2:
      type: object
      properties:
        salesforce:
          allOf:
          - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamSalesforceV2'
          description: Salesforce integration.
          readOnly: false
          writeOnly: false
      title: IamIntegrationsV2
    fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.ListItemFieldType:
      type: string
      description: Field data type within a List item.
      enum:
      - String
      - Boolean
      - DateTime
      - Numeric
      - Decimal
      title: ListItemFieldType
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantsResponse:
      type: object
      properties:
        operationId:
          type: string
          description: Unique identifier of the operation.
          example: 03f2d474-0508-46bf-9f3d-d8e2c28adaea
      required:
      - operationId
      title: AddFlowParticipantsResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleVersionDetailResponse:
      type: object
      description: The list of the results for this page.
      properties:
        id:
          type: integer
          format: int64
          description: Article version identifier.
          example: 42
        versionTimestamp:
          type: string
          format: date-time
          description: Timestamp when this version was created.
          example: '2025-06-15T10:30:00Z'
        author:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData'
        workflowStatus:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus'
        visibility:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility'
        workflowStatusModified:
          type: boolean
          description: Whether the workflow status was changed in this version.
          example: true
        contentModified:
          type: boolean
          description: Whether the content was changed in this version.
          example: false
        nameModified:
          type: boolean
          description: Whether the name was changed in this version.
          example: false
        tagsAdded:
          type: integer
          format: int32
          description: Number of tags added in this version.
          example: 2
        tagsRemoved:
          type: integer
          format: int32
          description: Number of tags removed in this version.
          example: 0
        attachmentsAdded:
          type: integer
          format: int32
          description: Number of attachments added in this version.
          example: 1
        attachmentsRemoved:
          type: integer
          format: int32
          description: Number of attachments removed in this version.
          example: 0
      required:
      - attachmentsAdded
      - attachmentsRemoved
      - author
      - contentModified
      - id
      - nameModified
      - tagsAdded
      - tagsRemoved
      - versionTimestamp
      - visibility
      - workflowStatus
      - workflowStatusModified
      title: ArticleVersionDetailResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageCategoryItemResponse:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CategoryItemResponse'
        paging:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo'
      required:
      - paging
      - results
      title: PageCategoryItemResponse
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPersonV2:
      type: object
      description: Person attributes. In case a person with either the specified <code>externalId</code> or <code>contactInformation</code> already exists in the People, the persons will be automatically merged. See <a href="https://www.infobip.com/docs/api/customer-engagement/moments/add-flow-participants" target="_blank">endpoint description</a> for more info.
      properties:
        createdAt:
          type: string
          description: 'Date and time of creation. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
        modifiedAt:
          type: string
          description: 'Date and time of last modification. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
        id:
          type: integer
          format: int64
          description: Unique id of the entity.
          readOnly: true
        externalId:
          type: string
          description: Unique ID for a person from your or another external system, 256 characters max.
        firstName:
          type: string
          description: Person's first name, 255 characters max.
        lastName:
          type: string
          description: Person's last name, 255 characters max.
        type:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.PublicIamTypeV2'
        address:
          type: string
          description: Person's title, 50 characters max.
        city:
          type: string
          description: Person's city, 50 characters max.
        country:
          type: string
          description: Person's country, 50 characters max.
        gender:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamGender'
        birthDate:
          type: string
          description: Person's date of birth, format `YYYY-MM-DD`.
        middleName:
          type: string
          description: Person's middle name, 50 characters max.
        preferredLanguage:
          type: string
          description: Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.
        profilePicture:
          type: string
          description: URL for the person's profile picture, 2083 characters max.
        origin:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.PublicIamOrigin'
        modifiedFrom:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.PublicIamOrigin'
        tags:
          type: array
          description: List of tags that this person has.
          items:
            type: string
            description: List of tags that this person has.
          uniqueItems: true
        customAttributes:
          type: object
          additionalProperties:
            type: object
          description: List of custom attributes for the person, 4096 characters max per value.
        contactInformation:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPersonContactsV2'
        integrations:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamIntegrationsV2'
        computedAttributes:
          type: object
          additionalProperties:
            type: object
          description: Person's computed attributes grouped by type.
      title: IamPersonV2
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ContactInformationTypeV3:
      type: string
      description: Type of the person ID.
      enum:
      - PHONE
      - EMAIL
      - FACEBOOK
      - LINE
      - TELEGRAM
      - PUSH
      - WEB_PUSH
      - LIVE_CHAT
      - VIBER_BOTS
      - INSTAGRAM
      - TWITTER
      - INSTAGRAM_DM
      - KAKAO_SANGDAM
      - APPLE_BUSINESS_CHAT
      - OPEN_CHANNEL
      - ZALO_FOLLOWER
      - TIKTOK_BM
      - WHATSAPP
      - KAKAO_TALK
      example: PHONE
      title: ContactInformationTypeV3
    265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonGenderV3:
      type: string
      description: Person's gender.
      enum:
      - MALE
      - FEMALE
      example: FEMALE
      title: PersonGenderV3
    f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.PersonsToCompanyEntry:
      type: object
      properties:
        query:
          allOf:
          - $ref: '#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery'
      title: PersonsToCompanyEntry
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TagsApiResponse:
      type: object
      example:
        tags:
        - name: Tag 1
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
        - name: Tag 2
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
        pagination:
          totalItems: 2
          page: 0
          limit: 10
          orderBy: id:ASC
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TagApiResponse'
        pagination:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination'
      title: TagsApiResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility:
      type: string
      description: Visibility of the node.
      enum:
      - PRIVATE
      - PUBLIC
      example: PUBLIC
      title: ContentVisibility
    f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.RequestStatusResponse:
      type: object
      example:
        requestId: 786ac8d6-40e5-4dfb-a450-4f71cbb3fc6c
        status: IN_PROGRESS
        details:
          account: 7CB64E2791F1A14E5BFEBED41A70F08D
          status: IN_PROGRESS
      properties:
        requestId:
          type: string
          description: Request identifier.
        status:
          $ref: '#/components/schemas/f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.StatusResponse'
        details:
          type: array
          description: Details about user request status.
          items:
            $ref: '#/components/schemas/f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.RequestDetailsResponse'
      required:
      - requestId
      - status
      title: RequestStatusResponse
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VoiceApiModel:
      type: object
      description: Used to define voice in which text will be synthesized. To get a list of the supported voices for chosen language use <a href="https://www.infobip.com/docs/api#channels/voice/get-voices" target="_blank">Get voices.</a>
      properties:
        name:
          type: string
          description: Name of the voice.
          maxLength: 36
          minLength: 1
        gender:
          type: string
          description: Gender of the voice. Can be MALE or FEMALE.
          maxLength: 36
          minLength: 1
      required:
      - gender
      - name
      title: VoiceApiModel
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique id of the waiting strategy.
        name:
          type: string
          description: Waiting strategy name.
        maximumWaitTime:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel'
        greetingMessage:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel'
        musicOnHold:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileAudioSourceApiModel'
        announcementMessage:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithPeriodicCollectApiModel'
        callbackConfirmationMessage:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel'
        maximumWaitTimeMessage:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel'
        conditionType:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.ConditionType'
        condition:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Condition'
        createdAt:
          type: string
          format: date-time
          description: Time at which the waiting strategy was created.
        updatedAt:
          type: string
          format: date-time
          description: Time stamp when waiting strategy is updated.
      title: WaitingStrategyApiResponse
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRole:
      type: string
      default: AGENT
      description: Agent role.
      enum:
      - AGENT
      - SUPERVISOR
      title: AgentRole
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AudioSourceTypeApiModel:
      type: string
      description: Specifies whether the audio is from a file source or text-to-speech
      enum:
      - TTS
      - FILE
      title: AudioSourceTypeApiModel
    25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.HolidaysApiModel:
      type: object
      description: List of working hours holidays.
      example:
        id: aae9b06f-a323-4c9c-b807-7a9e4e015405
        workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
        name: New Year's Day
        startDate: '2021-01-01'
        endDate: '2021-01-01'
        enabled: true
      properties:
        id:
          type: string
          description: Holiday ID.
          readOnly: true
        name:
          type: string
          description: Holiday name.
        startDate:
          type: string
          format: date-time
          description: 'Start date. Format: yyyy-MM-dd'
        endDate:
          type: string
          format: date-time
          description: 'End date. Format: yyyy-MM-dd'
        enabled:
          type: boolean
          description: Holiday enable/disable toggle.
      required:
      - name
      title: HolidaysApiModel
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamEmailContact:
      type: object
      description: A list of person's email addresses. Max 100 emails per person.
      properties:
        address:
          type: string
          description: Person's email address. Must comply with the [email format](https://tools.ietf.org/html/rfc2822) and cannot exceed 255 characters. One person can have up to 100 email addresses.
      title: IamEmailContact
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel:
      type: object
      example:
        topic: Topic
        summary: Summary
        status: OPEN
        priority: HIGH
        queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
        agentId: c856e230-a8cd-498b-9996-42bbed35029a
      properties:
        id:
          type: string
          description: Conversation Id.
          readOnly: true
        topic:
          type: string
          description: Conversation topic.
          maxLength: 1000
          minLength: 0
        summary:
          type: string
          description: Short description of the conversation.
          maxLength: 4000
          minLength: 0
        status:
          type: string
          default: OPEN
          description: Conversation status.
          enum:
          - OPEN
          - WAITING
          - SOLVED
          - CLOSED
        priority:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority'
        queueId:
          type: string
          description: Id of the queue conversation belongs to.
          maxLength: 255
          minLength: 0
        agentId:
          type: string
          description: Id of the agent assigned to the conversation.
          maxLength: 255
          minLength: 0
        createdAt:
          type: string
          format: date-time
          description: Time stamp when conversation is created.
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          description: Time stamp when conversation is updated.
          readOnly: true
        closedAt:
          type: string
          format: date-time
          description: If conversation is closed, time stamp when is closed.
          readOnly: true
      title: ConversationApiModel
    61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPushContactV2:
      type: object
      properties:
        additionalData:
          type: object
          additionalProperties:
            type: object
          description: Additional data collected from the user's profile
          readOnly: true
          writeOnly: false
        applicationId:
          type: string
          description: Application Id on which the user is subscribed.
          readOnly: true
          writeOnly: false
        isPrimary:
          type: boolean
          description: Set to true if this device is a primary device of a user among other devices.
          readOnly: true
          writeOnly: false
        registrationId:
          type: string
          description: Push registration ID.
          readOnly: true
          writeOnly: false
        systemData:
          type: object
          additionalProperties:
            type: object
          description: System data collected from the user's profile
          readOnly: true
          writeOnly: false
      title: IamPushContactV2
    2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse:
      type: object
      properties:
        results:
          type: array
          description: List of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists.
          items:
            $ref: '#/components/schemas/2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResult'
          readOnly: false
          writeOnly: false
      title: BatchUpdateResponse
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignStatsResponse:
      type: object
      properties:
        numberOfParticipants:
          type: integer
          default: 0
          description: Total number of unique participants in the campaign.
          title: Numberofparticipants
        averageScore:
          type: number
          description: Average score across all participants in the campaign.
          title: Averagescore
        lowestScore:
          type: number
          description: Lowest score recorded in the campaign.
          title: Lowestscore
        highestScore:
          type: number
          description: Highest score recorded in the campaign.
          title: Highestscore
        numberOfAttempts:
          type: integer
          default: 0
          description: Total number of attempts made across all participants in the campaign.
          title: Numberofattempts
      title: CampaignStatsResponse
    ApiRequestErrorDetails:
      type: object
      properties:
        messageId:
          type: string
          description: Identifier of the error.
        text:
          type: string
          description: Detailed error description.
        validationErrors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              description: Validation errors.
          description: Validation errors.
      title: ApiRequestErrorDetails
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OccurrenceConditionDto:
      type: object
      description: Specify how many times did the event occur.
      properties:
        operation:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OccurrenceConditionOperation'
        times:
          type: integer
          format: int32
          description: Number of times the event has occurred.
          example: 5
      required:
      - operation
      - times
      title: OccurrenceConditionDto
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.BotInformationExample:
      type: object
      description: Details about bot.
      properties:
        botId:
          type: integer
          format: int64
          description: Bot identifier.
        botSender:
          type: string
          description: Bot sender.
        botName:
          type: string
          description: Bot name.
        channel:
          $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingApiChannel'
        testId:
          type: integer
          format: int64
          description: Test identifier.
      required:
      - botId
      - botName
      - botSender
      - channel
      - testId
      title: BotInformationExample
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormPostResponse:
      type: object
      properties:
        conversationId:
          type: string
      title: WebFormPostResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleLinkDetailResponse:
      type: object
      description: List of Articles Or Attachments linked to the article.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the linked article or attachment.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        name:
          type: string
          description: Name of the linked article or attachment.
          example: API Reference Guide.pdf
        type:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.InternalType'
      required:
      - id
      - name
      - type
      title: ArticleLinkDetailResponse
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueResultPage:
      type: object
      example:
        queues:
        - id: a126beb1-f43b-422c-b298-295f65d31e82
          name: Queue 1
          enabledAgentsCount: 3
          enabledRoutesCount: 2
          isAutoAssignmentEnabled: false
          stickyAgentTimeoutDays: 10
          isStickyAutoAssignmentEnabled: true
          workingHoursId: null
          isPrivate: false
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          deletedAt: null
        - id: 75af6f92-75a6-4364-b293-450281bd21be
          name: Queue 2
          enabledAgentsCount: 1
          enabledRoutesCount: 4
          isAutoAssignmentEnabled: false
          stickyAgentTimeoutDays: null
          isStickyAutoAssignmentEnabled: false
          workingHoursId: null
          isPrivate: false
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          deletedAt: null
        pagination:
          totalItems: 2
          page: 0
          limit: 10
          orderBy: id:ASC
      properties:
        queues:
          type: array
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueApiModel'
        pagination:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination'
      title: QueueResultPage
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AuthorType:
      type: string
      description: Indicates if the message was written by the agent, bot, or the system.
      enum:
      - CUSTOMER
      - AGENT
      - SYSTEM
      - BOT
      title: AuthorType
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ValidationRules:
      type: object
      properties:
        datePattern:
          type: string
        maxLength:
          type: integer
          format: int32
        maxValue:
          type: string
        minValue:
          type: string
        pattern:
          type: string
        sample:
          type: string
        forbiddenSymbols:
          type: array
          items:
            type: string
      title: ValidationRules
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonPushContact:
      type: object
      description: A list of person's web push destinations.
      properties:
        applicationId:
          type: string
          description: Application Id on which the user is subscribed.
          readOnly: true
        registrationId:
          type: string
          description: Push registration ID.
          readOnly: true
        additionalData:
          type: object
          additionalProperties:
            type: object
            readOnly: true
          description: Unique user ID for a person.
          readOnly: true
        systemData:
          type: object
          additionalProperties:
            type: object
            readOnly: true
          description: System data collected from the user's profile.
          readOnly: true
      readOnly: true
      title: CommonPushContact
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.BadRequestResponse:
      type: object
      anyOf:
      - $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CustomBadRequestResponse'
      - $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse'
      title: BadRequestResponse
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TagApiResponse:
      type: object
      example:
        name: Tag 1
      properties:
        name:
          type: string
          description: Tag name. Numbers, uppercase and lowercase letters, along with '.' and '_' characters are allowed!
        id:
          type: string
          readOnly: true
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
      title: TagApiResponse
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountWrapUpApiModel:
      type: object
      example:
        wrapUpSeconds: 30
        canExtendWrapUp: true
        enabled: true
      properties:
        wrapUpSeconds:
          type: integer
          format: int32
          description: Wrap up duration.
        canExtendWrapUp:
          type: boolean
          description: Determines if agents can extend wrap up time.
        enabled:
          type: boolean
          description: Determines if wrap up is enabled for the account.
      required:
      - canExtendWrapUp
      - enabled
      - wrapUpSeconds
      title: AccountWrapUpApiModel
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.ContactInformationV3:
      type: object
      description: List of phones, emails and other information how a person can be contacted.
      properties:
        type:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.ContactInformationTypeV3'
        identifier:
          type: string
          description: Person ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request. 255 characters max.
          example: '41793026727'
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Sender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max.
          example: '41793026728'
          maxLength: 255
          minLength: 0
        primary:
          type: boolean
          description: Indicates if this ID is preferred for communication.
          example: true
      required:
      - identifier
      - type
      title: ContactInformationV3
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageArticleVersionDetailResponse:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleVersionDetailResponse'
        paging:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo'
      required:
      - paging
      - results
      title: PageArticleVersionDetailResponse
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest:
      type: array
      description: An array of events submitted as a batch request for processing.
      items:
        type: object
        properties:
          eventId:
            type:
            - string
            - 'null'
            description: Unique identifier of the event. If provided, it helps prevent duplicate events in case of retries—for example, if the first API call fails and the same event is sent again. Passing the same `eventId` ensures the event is only recorded once in the person profile.<br>The value must be `1–36` characters long and can include letters `(A–Z, a–z)`, digits `(0–9)`, underscores `(_)`, and hyphens `(-)` only.
          definitionId:
            type: string
            description: Unique identifier of event schema.
          occurredTime:
            type: string
            format: date-time
            description: Time of event occurrence, as the following format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Events occurred more than 30 days ago will be rejected. Future dates are not allowed and will be automatically set to the current UTC time.
            example: '2025-03-17T13:00:27.864Z'
          identifier:
            type: object
            description: 'Used to match the event to an existing person profile using the provided identifier.<br> If no matching profile is found, a new profile will be automatically created.<br>**Note**: New profiles can only be created for the following identifier types: `PHONE`, `EMAIL`, or `EXTERNAL_ID`.'
            properties:
              id:
                type: string
                description: Unique identifier of the person who performed the event. The value must match the `type` property.
              type:
                $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.PersonUniqueFieldType'
              sender:
                type:
                - string
                - 'null'
                description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`.
            required:
            - id
            - type
          properties:
            type:
            - object
            - 'null'
            additionalProperties:
              type: object
            description: Object containing event properties. Must match the corresponding event definition. See People Events [documentation](https://www.infobip.com/docs/people/events#properties-custom-events) for supported data types.
        required:
        - definitionId
        - identifier
        - occurredTime
      title: EventBatchResourceRequest
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CustomBadRequestResponse:
      type: object
      description: Bad request
      example:
        type: about:blank
        title: Bad Request
        status: 400
        detail: Failed to read request
        instance: /moments/1/flows/200000000000001/participants
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
          format: int32
        detail:
          type: string
        instance:
          type: string
      required:
      - detail
      - instance
      - status
      - title
      - type
      title: Bad Request Response
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagSimpleResponse:
      type: object
      description: Tags assigned to the article.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the tag.
          example: c56a4180-65aa-42ec-a945-5fd21dec0538
        name:
          type: string
          description: Name of the tag.
          example: sms
      required:
      - id
      - name
      title: TagSimpleResponse
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserPersonalizationRequest:
      type: object
      properties:
        identity:
          $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserIdentity'
        attributes:
          type: object
          description: Data specified in this object will be applied to the target person upon personalization
          properties:
            firstName:
              type: string
              description: User first name
            lastName:
              type: string
              description: User last name
            middleName:
              type: string
              description: User middle name
            birthday:
              type: string
              format: date-time
            gender:
              $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiGender'
            customAttributes:
              type: object
              additionalProperties:
                type: object
              description: Set of custom key-value pairs where value can be any of `string`, `number`, `boolean`
            tags:
              type: array
              description: Set of string labels attached to the user
              items:
                type: string
                description: Set of string labels attached to the user
              uniqueItems: true
      required:
      - identity
      title: PushUserPersonalizationRequest
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicAnswersEventExample:
      type: object
      properties:
        accountKey:
          type: string
          description: Account key.
        sessionInformation:
          $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.SessionInformationExample'
        timestamp:
          type: string
          format: date-time
          description: The timestamp of the event.
        lastDialog:
          $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.DialogInformation'
        outboundMessage:
          $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicOutboundMessage'
        type:
          $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.EventType'
      title: PublicAnswersEventExample
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicInboundMessage:
      type: object
      description: Inbound message.
      discriminator:
        propertyName: channel
        mapping:
          WHATSAPP: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicInboundMessage'
          CALLS: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicInboundMessage'
          LIVE_CHAT: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicInboundMessage'
      properties:
        channel:
          $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel'
      title: PublicInboundMessage
    bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin:
      type: string
      enum:
      - API
      - PORTAL
      - WEB_SDK
      - INTEGRATION
      - PUSH
      - FACEBOOK
      - LINE
      - TELEGRAM
      - SALESFORCE
      - DYNAMICS
      - ZAPIER
      - FORMS
      - COMPUTED
      - ANSWERS
      - CONVERSATIONS
      title: IamOrigin
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
      required:
      - errorCode
      - errorMessage
      title: PushApiErrorResponse
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority:
      type: string
      default: NORMAL
      description: Conversation priority.
      enum:
      - URGENT
      - HIGH
      - NORMAL
      - LOW
      title: ConversationPriority
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleRefResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the article.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      required:
      - id
      title: ArticleRefResponse
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OutboundCallConversationRequestApiModel:
      type: object
      example:
        from: '385998779621'
        to: '38761123123'
        agentId: 2010EA93ABC142E812C19F529BCBD22F
        voiceClientType: PSTN
      properties:
        from:
          type: string
          description: DID number that is used to originate the call. DID numbers can be configured through the portal, or using the 'Purchase a number' endpoint.
        to:
          type: string
          description: Destination number.
        agentId:
          type: string
          description: Id of the agent originating the call.
        voiceClientType:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VoiceClientType'
      required:
      - agentId
      - from
      - to
      title: OutboundCallConversationRequestApiModel
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageArticleListItemResponse:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleListItemResponse'
        paging:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo'
      required:
      - paging
      - results
      title: PageArticleListItemResponse
    8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateRequest:
      type: object
      properties:
        companies:
          type: array
          description: List of companies.
          items:
            $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2'
          readOnly: false
          writeOnly: false
      title: BatchCreateRequest
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationRoutingResultApiResponse:
      type: object
      properties:
        id:
          type: string
          description: Conversation Id.
        queueId:
          type: string
          description: Resolved queue Id.
        priority:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority'
      title: ConversationRoutingResultApiResponse
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger:
      type: object
      properties:
        title:
          type: string
          description: Trigger title.
          maxLength: 100
          minLength: 0
        expression:
          type: object
          additionalProperties:
            type: object
          description: Condition which resolves in destination form.
        orderIndex:
          type: integer
          format: int32
          description: Trigger order.
        isEnabled:
          type: boolean
          description: Is trigger enabled.
        formId:
          type: string
          description: Destination form.
        timesTriggered:
          type: integer
          format: int32
          description: Number of trigger resolution.
      required:
      - expression
      - formId
      - title
      title: Trigger
    c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateRequest:
      type: object
      properties:
        people:
          type: array
          description: List of people.
          items:
            $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
          readOnly: false
          writeOnly: false
      title: BatchCreateRequest
    f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.ShareResponse:
      type: object
      example:
        requestId: 786ac8d6-40e5-4dfb-a450-4f71cbb3fc6c
      properties:
        requestId:
          type: string
          description: Request identifier.
      required:
      - requestId
      title: ShareResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagRefResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the tag.
          example: c56a4180-65aa-42ec-a945-5fd21dec0538
      required:
      - id
      title: TagRefResponse
    0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute:
      type: object
      properties:
        createdAt:
          type: string
          description: 'Date and time of creation. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
          writeOnly: false
        dataType:
          allOf:
          - $ref: '#/components/schemas/9a0795f64a40f2cbc302ee52c186009a1de422921e2055e9284671cdc2107f5b.IamAdditionalFieldDataType'
          description: Custom attribute type.
          readOnly: false
          writeOnly: false
        modifiedAt:
          type: string
          description: 'Date and time of last modification. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
          writeOnly: false
        name:
          type: string
          description: 'Custom attribute name, 256 characters max. Invalid characters: `{}[]`.'
          readOnly: false
          writeOnly: false
        objectSchema:
          type: object
          additionalProperties:
            allOf:
            - $ref: '#/components/schemas/9a0795f64a40f2cbc302ee52c186009a1de422921e2055e9284671cdc2107f5b.IamAdditionalFieldDataType'
          description: Object schema for `LIST_OF_OBJECTS` type. Defines the shape of the list items.
          readOnly: false
          writeOnly: false
      title: IamCustomAttribute
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.DispositionBasic:
      type: object
      properties:
        conversationId:
          type: string
          description: Conversation id.
        formId:
          type: string
          description: Form id.
        fields:
          type: array
          description: A list of fields with values.
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.DispositionFieldBasic'
      title: DispositionBasic
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.PatchConversationApiRequest:
      type: object
      example:
        topic: Topic
        summary: Summary
        status: OPEN
        priority: HIGH
        queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
        agentId: c856e230-a8cd-498b-9996-42bbed35029a
      properties:
        topic:
          type: string
          description: Conversation topic.
          maxLength: 1000
          minLength: 0
        summary:
          type: string
          description: Short description of the conversation.
          maxLength: 4000
          minLength: 0
        status:
          type: string
          description: Conversation status.
          enum:
          - OPEN
          - WAITING
          - SOLVED
          - CLOSED
        priority:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority'
        queueId:
          type: string
          description: Id of the queue conversation belongs to.
          maxLength: 255
          minLength: 0
        agentId:
          type: string
          description: Id of the agent assigned to the conversation.
          maxLength: 255
          minLength: 0
      title: PatchConversationApiRequest
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeRequestDocsSchema:
      type: object
      properties:
        persons:
          type: array
          items:
            $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergePersonV3DocsSchema'
          maxItems: 1000
          minItems: 1
      title: MergeRequestDocsSchema
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormType:
      type: string
      description: Form type
      enum:
      - OPT_IN
      - OPT_OUT
      - FACEBOOK
      - LIVECHAT
      - APPLE
      - CSAT
      - WA_FLOW
      title: FormType
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamGender:
      type: string
      description: Person's gender.
      enum:
      - MALE
      - FEMALE
      title: IamGender
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.PageResponse:
      type: object
      properties:
        elements:
          type: array
          items:
            type: object
        total:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
      title: PageResponse
    fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionCategory:
      type: string
      description: Event definition category.
      enum:
      - external
      - person
      - channel
      - product
      - template
      title: EventDefinitionCategory
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StreamingResponseBody:
      type: object
      title: StreamingResponseBody
    6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest:
      type: object
      properties:
        people:
          type: array
          description: List of people.
          items:
            $ref: '#/components/schemas/6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagEntry'
          readOnly: false
          writeOnly: false
      title: BatchTagRequest
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldResultPage:
      type: object
      example:
        items:
        - id: d85b8e46-f579-482f-b383-22648aae17b5
          title: Type
          type: DROPDOWN
          isEnabled: true
          isDefault: null
          options:
          - inquiry
          - complaint
          createdAt: '2021-03-30T06:28:10.676028Z'
          updatedAt: '2021-03-30T06:28:10.676029Z'
          operators: []
        - id: e130e3f2-c8de-4ba9-a26e-8ac705642832
          title: Complaints
          type: TEXT
          isEnabled: true
          isDefault: null
          options: []
          createdAt: '2021-06-29T10:00:55.755685Z'
          updatedAt: '2021-06-29T10:00:55.755686Z'
          operators: []
        - id: ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc
          title: Inquiry
          type: TEXT
          isEnabled: true
          isDefault: null
          options: []
          createdAt: '2021-06-29T10:00:33.777564Z'
          updatedAt: '2021-06-29T10:00:33.777565Z'
          operators: []
        pagination:
          totalItems: 3
          page: 0
          limit: 10
          orderBy:
            property: id
            direction: ASC
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field'
        pagination:
          $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Pagination'
      title: FieldResultPage
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.LeaderboardEntry:
      type: object
      properties:
        name:
          type: string
          description: Name of the participant, if available.
          title: Name
        userId:
          type: string
          description: Unique identifier of the participant, usually in the format of a phone number, e.g., 00387123456.
          title: Userid
        score:
          type: integer
          description: Score of the participant in the leaderboard, ranging from 0 to 1000.
          title: Score
        date:
          type: string
          format: date-time
          description: Date and time when the score was recorded, in ISO 8601 format (e.g., 2023-10-01T00:00:00Z).
          title: Date
      required:
      - date
      - score
      - userId
      title: LeaderboardEntry
    0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.CustomAttributesResponse:
      type: object
      properties:
        customAttributes:
          type: array
          description: List of custom attributes.
          items:
            $ref: '#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute'
          readOnly: false
          writeOnly: false
        limit:
          type: integer
          format: int32
          description: Limit how many rows will be returned (but possibly less, if the query itself yields fewer rows)
          readOnly: false
          writeOnly: false
        orderBy:
          type: string
          description: Results ordering
          readOnly: false
          writeOnly: false
        page:
          type: integer
          format: int32
          description: Page number
          readOnly: false
          writeOnly: false
        totalCount:
          type: integer
          format: int64
          description: Total amount of rows
          readOnly: true
          writeOnly: false
      title: CustomAttributesResponse
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertOperationStatusV3:
      type: string
      description: Status indicating the type of operation performed on a person profile during upsert
      enum:
      - CREATED
      - UPDATED
      - NOT_MODIFIED
      title: UpsertOperationStatusV3
    d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery:
      type: object
      properties:
        identifier:
          type: string
          description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
          readOnly: false
          writeOnly: false
        sender:
          type: string
          description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`.
          readOnly: false
          writeOnly: false
        type:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
          description: Type of the person ID. Can be one of the above
          readOnly: false
          writeOnly: false
      title: IdentityQuery
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource:
      type: object
      additionalProperties: false
      properties:
        isInternalDefinition:
          type: boolean
          description: Indicates whether this is a standard (internal) event definition provided by the system, or a custom (external) definition created by the user.
        category:
          type: 'null'
          allOf:
          - $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionCategory'
          description: Event definition category.
        subcategory:
          type: 'null'
          allOf:
          - $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionSubcategory'
          description: Event definition subcategory, providing more granular classification within the main category.
        definitionId:
          type:
          - string
          - 'null'
          description: Event definition identifier.
        title:
          type:
          - string
          - 'null'
          description: Event definition title.
        description:
          type:
          - string
          - 'null'
          description: Event definition description.
        fields:
          type:
          - array
          - 'null'
          description: Event definition fields describing the structure and data types of the event properties.
          items:
            $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventFieldResource'
          uniqueItems: true
      title: EventDefinitionResource
    8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResult:
      type: object
      properties:
        errors:
          type: array
          description: List of errors
          items:
            $ref: '#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError'
          readOnly: false
          writeOnly: false
        id:
          type: integer
          format: int64
          description: Id of created company
          readOnly: false
          writeOnly: false
        index:
          type: integer
          format: int32
          description: Index of company in request list
          readOnly: false
          writeOnly: false
        status:
          type: integer
          format: int32
          description: HTTP status
          readOnly: false
          writeOnly: false
      title: BatchCreateResult
    a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.DefinitionsResponseBody:
      type: object
      properties:
        definitionIdList:
          type: array
          description: Available `definitionId`s.
          items:
            type: string
            description: Available `definitionId`s.
            readOnly: true
          readOnly: true
      required:
      - definitionIdList
      title: DefinitionsResponseBody
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType:
      type: string
      description: Content type
      enum:
      - TEXT
      - IMAGE
      - LOCATION
      - TEMPLATE
      - AUDIO
      - UNKNOWN
      - VOICE
      - VIDEO
      - DOCUMENT
      - CONTACT
      - VOICE_CALL
      - VIDEO_CALL
      - BUTTON
      - TYPING_INDICATOR
      - LIST_PICKER
      - FILE
      - LIST_PICKER_RESPONSE
      - POSTBACK
      - WA_BUTTON_FEEDBACK
      - SURVEY_REQUEST
      - SURVEY_RESPONSE
      - MEDIA_TEMPLATE
      - FACEBOOK_TEMPLATE
      - PRE_CHAT_FORM
      - LC_QUICK_REPLY
      - TEXT_WITH_BUTTON
      - TEXT_WITH_IMAGE_AND_BUTTON
      - SUGGESTION_RESPONSE
      - ABC_MULTI_TYPE
      - FOLLOW
      - UNFOLLOW
      - CALL
      - EMAIL
      - CARD
      - CAROUSEL
      - TEXT_WITH_SUGGESTION
      - RICH_LINK
      - TIME_PICKER
      - TIME_PICKER_RESPONSE
      - BUTTON_RESPONSE
      - VIBER_BOT_STICKER
      - WHATSAPP_STICKER
      - VIBER_BOT_CAROUSEL
      - VIBER_BOT_EVENT
      - VIBER_BOT_VIDEO
      - VIBER_BOT_FILE
      - URL
      - LC_CAROUSEL
      - INSTAGRAM_STICKER
      - CALL_START
      - CALL_HANGUP
      - CALL_TRANSCRIPT
      - CALL_FILE
      - APPLE_CUSTOM_INTERACTIVE_CONTENT
      - APPLE_AUTH_REQUEST_CONTENT
      - APPLE_PAY_REQUEST_CONTENT
      - APPLE_PAY_RESPONSE
      - AUTHENTICATION_RESPONSE
      - CLOSE_CONVERSATION
      - BUTTON_LIST
      - KAKAO_SANGDAM_SESSION_EXPIRED
      - INSTAGRAM_TEMPLATE
      - SHARE
      - STORY_MENTION
      - CUSTOM_INTERACTIVE_RESPONSE
      - INTERACTIVE
      - INTERACTIVE_LIST_REPLY
      - INTERACTIVE_BUTTON_REPLY
      - LC_FORM_RESPONSE
      - PRODUCT
      - APPLE_QUICK_REPLY_CONTENT
      - QUICK_REPLY
      - WHATSAPP_PRODUCT
      - WHATSAPP_MULTI_PRODUCT
      - WHATSAPP_TEXT_WITH_ADDITIONAL_DATA
      - ORDER
      - TELEGRAM_CONTACT
      - FORM_RESPONSE
      - LINE_TEMPLATE
      - APPLE_FORM_CONTENT
      - LINE_POSTBACK_EVENT
      - LIVE_CHAT_KNOWLEDGE_BASE_ARTICLE
      - LIVE_CHAT_KNOWLEDGE_BASE_SEARCH
      - LINE_STICKER
      - INTERACTIVE_FLOW_REPLY
      - RCS_TEXT
      - RCS_FILE
      - RCS_CARD
      - RCS_CAROUSEL
      - BUNDLE
      - PRIVATE_REPLY_TO_SOCIAL_COMMENT
      - LIVE_CHAT_BUTTON
      - TEXT_WITH_RATING
      - EMPTY
      - JSON
      - ROADSIDE_ASSISTANCE
      - CUSTOM_DATA
      - WHATSAPP_CALL_PERMISSION_REPLY
      - TIKTOK_SHARE_POST
      - TIKTOK_REFERRAL_SHORT_LINK
      - TIKTOK_REFERRAL_AD
      - ZALO_GIF
      - TEXT
      - IMAGE
      - LOCATION
      - TEMPLATE
      - AUDIO
      - VOICE
      - VIDEO
      - DOCUMENT
      - CONTACT
      - VOICE_CALL
      - VIDEO_CALL
      - CALL
      - BUTTON
      - TYPING_INDICATOR
      - LIST_PICKER
      - FILE
      - LIST_PICKER_RESPONSE
      - POSTBACK
      - SURVEY_REQUEST
      - SURVEY_RESPONSE
      - FACEBOOK_TEMPLATE
      - PRE_CHAT_FORM
      - LC_FORM_RESPONSE
      - LC_QUICK_REPLY
      - LC_CAROUSEL
      - LIVE_CHAT_KNOWLEDGE_BASE_ARTICLE
      - LIVE_CHAT_KNOWLEDGE_BASE_SEARCH
      - TEXT_WITH_BUTTON
      - TEXT_WITH_IMAGE_AND_BUTTON
      - ABC_MULTI_TYPE
      - CARD
      - SUGGESTION_RESPONSE
      - CAROUSEL
      - LINE_TEMPLATE
      - TEXT_WITH_SUGGESTION
      - EMAIL
      - RICH_LINK
      - TIME_PICKER
      - TIME_PICKER_RESPONSE
      - BUTTON_RESPONSE
      - WHATSAPP_STICKER
      - VIBER_STICKER
      - INSTAGRAM_STICKER
      - INSTAGRAM_TEMPLATE
      - CALL_FILE
      - CALL_TRANSCRIPT
      - CALL_HANGUP
      - CALL_START
      - ABC_CUSTOM_INTERACTIVE_CONTENT
      - APPLE_PAY_REQUEST_CONTENT
      - QUICK_REPLY
      - APPLE_AUTH_REQUEST_CONTENT
      - APPLE_CUSTOM_INTERACTIVE_CONTENT
      - BUTTON_LIST
      - SHARE
      - INTERACTIVE
      - KAKAO_SANGDAM_SESSION_EXPIRED
      - INTERACTIVE_BUTTON_REPLY
      - INTERACTIVE_LIST_REPLY
      - WHATSAPP_PRODUCT
      - WHATSAPP_MULTI_PRODUCT
      - PRODUCT
      - APPLE_QUICK_REPLY_CONTENT
      - APPLE_FORM_CONTENT
      - ROADSIDE_ASSISTANCE
      - FORM_RESPONSE
      - ORDER
      - LINE_POSTBACK_EVENT
      - INTERACTIVE_FLOW_REPLY
      - RCS_TEXT
      - RCS_FILE
      - RCS_CARD
      - RCS_CAROUSEL
      - PRIVATE_REPLY_TO_SOCIAL_COMMENT
      - CUSTOM_DATA
      - WHATSAPP_CALL_PERMISSION_REPLY
      title: ContentType
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotResultPage:
      type: object
      example:
        bots:
        - id: 309BB921757DEAC9BE79EC6259B31C8A
          webhookUrl: www.webhookurl.com/link1
          displayName: My Whatsapp Bot
          channel: WHATSAPP
          destination: '447492263897'
          messagePersistencePolicy: PERSIST_ALL
          enabled: true
          sessionTimeoutInSec: 120
        - id: 6988D4642270FD8EF9EA833DCD972BB1
          webhookUrl: www.webhookurl.com/link2
          displayName: My Secret Bot
          channel: WHATSAPP
          destination: '447492263899'
          messagePersistencePolicy: PERSIST_NONE
          enabled: true
          sessionTimeoutInSec: 120
        pagination:
          totalItems: 2
          page: 0
          limit: 10
          orderBy: id:ASC
      properties:
        bots:
          type: array
          items:
            $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotApiModel'
        pagination:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Pagination'
      title: BotResultPage
    d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse:
      type: object
      properties:
        results:
          type: array
          description: List of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists.
          items:
            $ref: '#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResult'
          readOnly: false
          writeOnly: false
      title: BatchDeleteResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagUpdateRequest:
      type: object
      properties:
        name:
          type: string
          description: New name for the tag.
          example: email-api
          pattern: ^[^,]+$
      required:
      - name
      title: TagUpdateRequest
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedCommentsApiResponse:
      type: object
      example:
        conversationsMessage:
          id: 1
          channel: FACEBOOK_POST
          from: '55555544444433333'
          to: '999990000011111'
          direction: INBOUND
          conversationId: 3f8c9a2e-1b6f-4d3a-9f5b-2e4b6c8d9e7f
          authorId: 7a1d5b4c-8e2f-4c3b-b9a1-5f6d7e8f9a0b
          authorType: CUSTOMER
          createdAt: '2025-01-10T08:51:23.100+00:00'
          updatedAt: '2025-01-10T08:51:23.100+00:00'
          content:
            text: Hello!
            showUrlPreview: null
          singleSendMessage:
            from:
              id: '55555544444433333'
              type: SOCIAL_USER
            to:
              externalId: '999990000011111'
              type: SOCIAL_PAGE
            content:
              commentMoContent:
                text: Hello!
                type: TEXT
              type: COMMENT
            socialContext:
              externalId: '999990000011111_123456789123457'
              postId: '987654321987_999990000011112'
              parentId: null
              permalinkUrl: null
              extCreated: '2025-01-10T08:51:23.100+00:00'
              username: John Doe
              actionType: ADD
            channel: FACEBOOK_POST
            direction: INBOUND
          contentType: TEXT
        olderComments:
        - id: null
          channel: FACEBOOK_POST
          authorName: John Doe:123456789
          direction: INBOUND
          conversationId: a06b6abc-1c8f-4b4f-8600-f4f651418e8f
          createdAt: '2025-01-09T08:51:23.100+00:00'
          content:
            text: Test
            showUrlPreview: null
          singleSendMessage:
            from:
              id: '55555544444433333'
              type: SOCIAL_USER
            to:
              externalId: '999990000011111'
              type: SOCIAL_PAGE
            content:
              commentMoContent:
                text: Test
                type: TEXT
              type: COMMENT
            socialContext:
              externalId: '999990000011111_123456789123456'
              postId: '987654321987_999990000011111'
              parentId: null
              permalinkUrl: null
              extCreated: '2025-01-09T08:51:17Z'
              username: John Doe
              actionType: ADD
            channel: FACEBOOK_POST
            direction: INBOUND
          contentType: TEXT
        newerComments:
        - id: null
          channel: FACEBOOK_POST
          authorName: Peter Northrop:8132498432
          direction: OUTBOUND
          conversationId: e50588de-123b-45c8-9f58-8e3376805646
          createdAt: '2025-02-18T13:56:10.465+00:00'
          content:
            socialMentions: []
            text: '@John Doe OK'
            showUrlPreview: null
          singleSendMessage:
            from:
              externalId: '999990000011111'
              type: SOCIAL_PAGE
            to:
              id: '8132498432'
              type: SOCIAL_USER
            content:
              text: '@John Doe OK'
              type: TEXT
            replyToCommentId: '999990000011111_546621549845623'
            mentions: []
            channel: FACEBOOK_POST
            direction: OUTBOUND
          contentType: TEXT
      properties:
        conversationsMessage:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageApiResponse'
        olderComments:
          type: array
          description: Returns up to 50 comments created before the specified inbound comment, at the same level of the conversation.
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedMessageApiResponse'
        newerComments:
          type: array
          description: Returns up to 50 comments created after the specified inbound comment, at the same level of the conversation.
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedMessageApiResponse'
      title: RelatedCommentsApiResponse
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.PublicIamOrigin:
      type: string
      description: The information which describes the source of the last modification of record.
      enum:
      - API
      - PORTAL
      - WEB_SDK
      - INTEGRATION
      - PUSH
      - FACEBOOK
      - LINE
      - TELEGRAM
      - SALESFORCE
      - DYNAMICS
      - ZAPIER
      - FORMS
      - COMPUTED
      - ANSWERS
      - CONVERSATIONS
      readOnly: true
      title: PublicIamOrigin
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertSuccessResult:
      type: object
      description: Successful result for a person upsert operation.
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the upserted person profile.
        index:
          type: integer
          format: int32
          description: Index position of this person in the original request batch.
        status:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertOperationStatusV3'
      title: UpsertSuccessResult
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonV3:
      type: object
      description: The list of the results for this page.
      properties:
        id:
          type: integer
          format: int64
          description: Unique id of the entity.
          example: 1
          readOnly: true
        externalId:
          type: string
          description: Unique ID for a person from your or another external system, 256 characters max.
          example: '3'
          maxLength: 256
          minLength: 0
        type:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonTypeV3'
        firstName:
          type: string
          description: Person's first name, 255 characters max.
          example: Jane
          maxLength: 255
          minLength: 0
        middleName:
          type: string
          description: Person's middle name, 50 characters max.
          example: Janie
          maxLength: 50
          minLength: 0
        lastName:
          type: string
          description: Person's last name, 255 characters max.
          example: Smith
          maxLength: 255
          minLength: 0
        nickName:
          type: string
          description: Person's nick name, 50 characters max.
          example: Janey
          maxLength: 50
          minLength: 0
        country:
          type: string
          description: Person's country, 50 characters max.
          example: United Kingdom
          maxLength: 50
          minLength: 0
        city:
          type: string
          description: Person's city, 50 characters max.
          example: London
          maxLength: 50
          minLength: 0
        address:
          type: string
          description: Person's address, 256 characters max.
          example: 67 Farringdon Road
          maxLength: 256
          minLength: 0
        gender:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonGenderV3'
        preferredLanguage:
          type: string
          description: Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.
          example: en-gb
        birthDate:
          type: string
          format: date
          description: Person's date of birth, format `YYYY-MM-DD`.
          example: '1966-01-15'
        profilePicture:
          type: string
          format: url
          description: URL for the person's profile picture, 2083 characters max.
          example: http://profile.com
          maxLength: 2083
          minLength: 0
        tags:
          type: array
          description: List of tags that this person has.
          example:
          - tag1
          - tag2
          items:
            type: string
            description: List of tags that this person has.
            example: '["tag1","tag2"]'
          uniqueItems: true
        contactInformation:
          type: array
          description: List of phones, emails and other information how a person can be contacted.
          items:
            $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.ContactInformationV3'
        customAttributes:
          type: object
          additionalProperties:
            type: object
            example:
              Contract Expiry: '2024-06-12'
              Company: ACME
          description: List of custom attributes for the person, 4096 characters max per value.
          example:
            Contract Expiry: '2024-06-12'
            Company: ACME
        computedAttributes:
          type: object
          additionalProperties:
            type: object
            example:
              fullName: Jane Smith
            readOnly: true
          description: Person's computed attributes grouped by type.
          example:
            fullName: Jane Smith
          readOnly: true
        createdFrom:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OriginV3'
        createdBy:
          type: string
          description: Identifier of the user who created this person record.
          example: '5'
          readOnly: true
        createdAt:
          type: string
          format: date-time
          description: 'Date and time of creation. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
        modifiedFrom:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OriginV3'
        modifiedBy:
          type: string
          description: Identifier of the user who last modified this person record.
          example: '5'
          readOnly: true
        modifiedAt:
          type: string
          format: date-time
          description: 'Date and time of last modification. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
      title: PersonV3
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPlaceholderSayAsApiModel:
      type: string
      description: "Dictates how resolved value will be spoken when using the placeholder.\n DEFAULT means that there is no control as to how the value will be spoken and it depends on the TTS engine.\n ORDINAL means that the value will be spoken as an ordinal number.\n CARDINAL means that the value will be spoken as a cardinal number.\n"
      enum:
      - DEFAULT
      - ORDINAL
      - CARDINAL
      - DEFAULT
      - ORDINAL
      - CARDINAL
      title: TtsPlaceholderSayAsApiModel
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationPhone:
      type: object
      properties:
        number:
          type: string
      title: ContactInformationPhone
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIErrorResources:
      type: object
      properties:
        name:
          type: string
          description: Resource name.
          title: Name
        url:
          type: string
          description: Resource URL.
          title: Url
      required:
      - name
      - url
      title: APIErrorResources
    25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursStatusApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursStatus'
      title: WorkingHoursStatusApiResponse
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageApiResponse:
      type: object
      properties:
        id:
          type: string
          description: Message Id
        channel:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageChannel'
        from:
          type: string
          description: Sender phone number, email address, FB messenger Id or live chat widget Id.
        to:
          type: string
          description: Destination phone number, email address, FB messenger or live chat user Id.
        direction:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageDirection'
        conversationId:
          type: string
          description: Id of the conversation message belongs to.
        authorId:
          type: string
          description: Internal unique ID of the customer or agent, determined by the author type.
        authorType:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AuthorType'
        createdAt:
          type: string
          format: date-time
          description: Time stamp when message is created.
        updatedAt:
          type: string
          format: date-time
          description: Time stamp when message is updated.
        content:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageContent'
        contentType:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType'
      title: MessageApiResponse
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.ContactInformationTypeV3:
      type: string
      description: Type of the person ID
      enum:
      - PHONE
      - EMAIL
      - FACEBOOK
      - LINE
      - TELEGRAM
      - PUSH
      - WEB_PUSH
      - LIVE_CHAT
      - VIBER_BOTS
      - INSTAGRAM
      - TWITTER
      - INSTAGRAM_DM
      - KAKAO_SANGDAM
      - APPLE_BUSINESS_CHAT
      - OPEN_CHANNEL
      - ZALO_FOLLOWER
      - TIKTOK_BM
      - WHATSAPP
      - KAKAO_TALK
      example: PHONE
      title: ContactInformationTypeV3
    25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.Pagination:
      type: object
      properties:
        totalItems:
          type: integer
          format: int64
          readOnly: true
        page:
          type: integer
          format: int32
          readOnly: true
        limit:
          type: integer
          format: int32
          readOnly: true
        orderBy:
          type: string
          readOnly: true
      title: Pagination
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormElementOptionDto:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
        additionalConfiguration:
          type: object
          additionalProperties:
            type: string
      required:
      - name
      - value
      title: FormElementOptionDto
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingApiChannel:
      type: string
      description: Channel name.
      enum:
      - WHATSAPP
      - LIVE_CHAT
      - CALLS
      title: TestingApiChannel
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPhoneContact:
      type: object
      description: A list of person's phone numbers. Max 100 numbers per person.
      properties:
        number:
          type: string
          description: Person's phone number. Must be in [international format](https://en.wikipedia.org/wiki/E.164) and cannot exceed 50 characters. One person can have up to 100 phone numbers.
      title: IamPhoneContact
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentLinkedArticleResponse:
      type: object
      properties:
        articleId:
          type: string
          format: uuid
          description: Unique identifier of the linked article.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      required:
      - articleId
      title: AttachmentLinkedArticleResponse
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.EventType:
      type: string
      description: The type of the event.
      enum:
      - MESSAGE_SENT
      - GET_ATTRIBUTE_VALUE_QUESTION_SENT
      - CSAT_FEEDBACK_QUESTION_SENT
      - CSAT_FALLBACK_MESSAGE_SENT
      - CSAT_SCORE_QUESTION_SENT
      - CSAT_THANK_YOU_MESSAGE_SENT
      - PUI_REPEAT_MESSAGE_SENT
      - FALLBACK_MESSAGE_SENT
      - TIMEOUT_MESSAGE_SENT
      - INTERACTIVE_MESSAGE_SENT
      title: EventType
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileAudioSourceApiModel:
      type: object
      description: File audio source information.
      properties:
        enabled:
          type: boolean
        fileAudioSource:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel'
      title: OptionWithFileAudioSourceApiModel
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageTreeNodeResponse:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse'
        paging:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo'
      required:
      - paging
      - results
      title: PageTreeNodeResponse
    62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteEntry:
      type: object
      properties:
        query:
          allOf:
          - $ref: '#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.CompanyIdentityQuery'
      title: BatchDeleteEntry
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel:
      type: object
      description: File audio source information.
      properties:
        fileDescriptor:
          type: string
          description: File audio source descriptor.
          maxLength: 128
          minLength: 0
      title: FileAudioSourceApiModel
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserIdentity:
      type: object
      description: Unique identifiers from this object will be used to find a person to personalize push registration with
      properties:
        externalId:
          type: string
          description: 'Id of a user in external system. **Notice**: for `externalId` any string values such as `"null"`, `"Null"` or `"NULL"` are not supported and would be considered as JSON `null`'
        email:
          type: string
          description: User email
        phoneNumber:
          type: string
          description: User phone number according to E.164 general format
      title: PushUserIdentity
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamSalesforceV2:
      type: object
      description: Salesforce integration.
      properties:
        leadId:
          type: string
          description: Salesforce lead id.
        contactId:
          type: string
          description: Salesforce contact id.
      title: IamSalesforceV2
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldOperator:
      type: string
      description: List of available operators based on field type.
      enum:
      - IS
      - IS_NOT
      - CONTAINS
      - DOESNT_CONTAIN
      - IS_SELECTED
      - NOT_SELECTED
      - IS_EQUAL_TO
      - NOT_EQUAL_TO
      - LESS_THAN
      - GREATER_THAN
      - IS_EQUAL_OR_LESS
      - IS_EQUAL_OR_GREATER
      - BEFORE
      - AFTER
      - BEFORE_OR_ON
      - AFTER_OR_ON
      title: FieldOperator
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionUnits:
      type: string
      description: Time units for relative operators.
      enum:
      - DAYS
      - HOURS
      - MINUTES
      example: DAYS
      title: TimelineConditionUnits
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateNoteApiRequest:
      type: object
      properties:
        type:
          type: string
          default: INTERNAL
          enum:
          - INTERNAL
          - ATTACHMENT
        content:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteContent'
        agentId:
          type: string
          description: Agent Id, creator of note.
          maxLength: 255
          minLength: 0
      required:
      - content
      title: CreateNoteApiRequest
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorResponseV3:
      type: object
      description: Error information for failed batch operation items.
      properties:
        code:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorCodeV3'
        message:
          type: string
          description: Human-readable error message describing what went wrong.
        details:
          type: array
          description: Additional validation error details with specific property-level information.
          items:
            $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorDetail'
        index:
          type: integer
          format: int32
          description: Index position of the failed item in the original request batch.
      title: ErrorResponseV3
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstanceSystemData:
      type: object
      description: Set of push-specific attributes
      properties:
        cloudType:
          $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.CloudType'
        registrationEnabled:
          type: boolean
          description: State of the device registration
        notificationsEnabled:
          type: boolean
          description: Set to `true` if notifications are enabled on a device
          readOnly: true
        geofencingSdk:
          type: boolean
          deprecated: true
          description: 'Set to `true` if geo fencing is enabled on a device. **Deprecated: This property is no longer in use since iOS SDK version 12.19.0 and Android SDK version 13.0.3.**'
          readOnly: true
        sdkVersion:
          type: string
          description: SDK version that is running on a device
          readOnly: true
        appVersion:
          type: string
          description: The version of the application which SDK is embedded into
          readOnly: true
        os:
          $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.OperatingSystem'
        osVersion:
          type: string
          description: The version of the operating system
          readOnly: true
        deviceManufacturer:
          type: string
          description: The manufacturer of the device as detected by the SDK
          readOnly: true
        deviceModel:
          type: string
          description: The model of the device
          readOnly: true
        deviceSecure:
          type: boolean
          description: Set to `true` if the device has any type of secure screen lock set up
          readOnly: true
        osLanguage:
          type: string
          description: An identifier of the language used on a device
          readOnly: true
        deviceTimezoneOffset:
          type: string
          description: UTC-related timezone offset that identifies a current timezone of a device
          readOnly: true
        deviceName:
          type: string
          description: The name of the device as configured by a user
          readOnly: true
      title: PushApiInstanceSystemData
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.QueueAssignRequest:
      type: object
      example:
        queueId: 1111222233334444AAAA8888FFFF6666
      properties:
        queueId:
          type: string
          description: queueId identifier
          maxLength: 255
          minLength: 0
      required:
      - queueId
      title: QueueAssignRequest
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormRequest:
      type: object
      properties:
        title:
          type: string
          description: Form title.
          maxLength: 100
          minLength: 0
        isEnabled:
          type: boolean
          description: Is form enabled. Mandatory when updating.
        isDefault:
          type: boolean
          description: Is form default.
        fields:
          type: array
          description: Fields attached to a form.
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormFieldRequest'
          maxItems: 2147483647
          minItems: 1
      required:
      - fields
      - isEnabled
      - title
      title: FormRequest
    f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.CompaniesResponse:
      type: object
      properties:
        companies:
          type: array
          description: List of companies.
          items:
            $ref: '#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2'
          readOnly: false
          writeOnly: false
        limit:
          type: integer
          format: int32
          description: Limit how many rows will be returned (but possibly less, if the query itself yields fewer rows)
          readOnly: false
          writeOnly: false
        orderBy:
          type: string
          description: Results ordering
          readOnly: false
          writeOnly: false
        page:
          type: integer
          format: int32
          description: Page number
          readOnly: false
          writeOnly: false
        totalCount:
          type: integer
          format: int64
          description: Total amount of rows
          readOnly: true
          writeOnly: false
      title: CompaniesResponse
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateQueueApiRequest:
      type: object
      example:
        name: Spanish Support
      properties:
        name:
          type: string
          description: Name of the queue.
          maxLength: 255
          minLength: 0
        isAutoAssignmentEnabled:
          type: boolean
          default: false
          description: Auto-assignment of the queue.
        workingHoursId:
          type: string
          description: Working hours Id queue belongs to
        externalId:
          type: string
      required:
      - name
      title: CreateQueueApiRequest
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse:
      type: object
      description: A structured response that provides detailed information about validation errors encountered during an API request.
      properties:
        status:
          type: integer
          format: int32
          description: The HTTP status code indicating the nature of the error.
        title:
          type: string
          description: A short, human-readable summary of the error type. This title remains consistent across similar error occurrences, aiding in easy identification.
        type:
          type: string
          format: uri
          description: A URI reference that provides additional information about the error type.
        traceId:
          type: string
          description: A unique identifier for the request, useful for tracing purposes. This ID helps in correlating logs and tracking the request through the system.
        errors:
          type: array
          description: An array containing detailed information about each error encountered.
          items:
            $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsResponse'
      required:
      - status
      - title
      - type
      title: ProblemDetailsResponse
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchResponse:
      type: object
      properties:
        matches:
          type: array
          description: List of matches.
          items:
            $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchAmgModel'
      title: MatchResponse
    ApiErrorResource:
      type: object
      description: List of available resources to recover from the error.
      properties:
        name:
          type: string
          description: Resource name.
        url:
          type: string
          description: Resource URL.
      title: ApiErrorResource
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedMessageApiResponse:
      type: object
      description: Returns up to 50 comments created after the specified inbound comment, at the same level of the conversation.
      properties:
        id:
          type: string
          description: Unique ID of the comment.
        channel:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageChannel'
        authorName:
          type: string
          description: Facebook or Instagram username.
        direction:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageDirection'
        conversationId:
          type: string
          description: ID of the conversation to which the message belongs.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when message was created.
        content:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageContent'
        contentType:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType'
      title: RelatedMessageApiResponse
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.ConditionalField:
      type: object
      description: List of fields to present if agent input matches condition value.
      properties:
        field:
          $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field'
        isRequired:
          type: boolean
          description: Is the conditional field required to fill?
      title: ConditionalField
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreBase:
      type: object
      properties:
        campaignId:
          type: string
          format: uuid
          description: Unique identifier of the campaign the score belongs to.
          title: Campaignid
        userId:
          type: string
          description: User ID, usually in the format of a phone number, e.g., 00387123456.
          examples:
          - 00387123456
          title: Userid
        name:
          type: string
          description: Name of the participant e.g. John Smith. Maximum 300 characters long. Cannot be empty or whitespace.
          title: Name
        audioUrl:
          type: string
          description: URL of the audio file used for sound matching. Must be a valid URL pointing to an audio file.
          examples:
          - https://www.example.com/audio/test.wav
          title: Audiourl
        languageCode:
          type: string
          description: Language code of the audio file, e.g., 'en-US' for English. This should match the language of the audio file being submitted.
          examples:
          - en-US
          title: Languagecode
        channel:
          $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.Channel'
          default: UNKNOWN
      required:
      - audioUrl
      - campaignId
      - languageCode
      - userId
      title: ScoreBase
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateTagApiResponse:
      type: object
      description: List of template tags.
      example:
        name: Template tag
        createdAt: '2024-01-01T00:00:00.000+00:00'
        updatedAt: '2024-01-01T00:00:00.000+00:00'
      properties:
        id:
          type: string
          description: Template tag ID.
        name:
          type: string
          description: Template tag name.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when template tag was created.
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when template tag was updated.
      title: TemplateTagApiResponse
    62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResult:
      type: object
      properties:
        errors:
          type: array
          description: List of errors
          items:
            $ref: '#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError'
          readOnly: false
          writeOnly: false
        query:
          type: object
          additionalProperties:
            type: object
          description: Query used for company identification
          readOnly: false
          writeOnly: false
        status:
          type: integer
          format: int32
          description: HTTP status
          readOnly: false
          writeOnly: false
      title: BatchDeleteResult
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse:
      type: object
      properties:
        eventId:
          type: string
          description: Unique identifier of the event.
        definitionId:
          type: string
          description: Unique identifier of event schema.
        occurredTime:
          type: string
          format: date-time
          description: 'Time of event occurrence, as the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
          example: '2024-05-17T15:47:50.413Z'
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            type: object
          description: Object that contains event properties.
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type: object
          description: Object that contains metadata of event occurrence.
      title: EventResourceResponse
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PagePersonV3:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonV3'
        paging:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageInfo'
      required:
      - paging
      - results
      title: PagePersonV3
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertContactInformationV3DocsSchema:
      type: object
      description: List of phones, emails and other information how a person can be contacted.
      properties:
        type:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ContactInformationTypeV3Upsert'
        identifier:
          type: string
          description: Person ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request. 255 characters max.
          example: '41793026727'
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Sender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max.
          example: '41793026728'
          maxLength: 255
          minLength: 0
        primary:
          type: boolean
          description: Indicates if this ID is preferred for communication.
          example: true
      title: UpsertContactInformationV3DocsSchema
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ContactInformationTypeV3Upsert:
      type: string
      description: Type of the person ID.
      enum:
      - PHONE
      - EMAIL
      example: PHONE
      title: ContactInformationTypeV3Upsert
    a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.ExportResponseBody:
      type: object
      properties:
        requestId:
          type: string
          description: Event export request ID.
          readOnly: true
      required:
      - requestId
      title: ExportResponseBody
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.OperatingSystem:
      type: string
      description: Operating system type can be `Android` or `iOS`
      enum:
      - Android
      - iOS
      readOnly: true
      title: OperatingSystem
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OriginV3:
      type: string
      description: Source system that last modified this person record.
      enum:
      - API
      - PORTAL
      - WEB_SDK
      - INTEGRATION
      - PUSH
      - FACEBOOK
      - LINE
      - TELEGRAM
      - SALESFORCE
      - DYNAMICS
      - ZAPIER
      - FORMS
      - AMS
      - COMPUTED
      - ANSWERS
      - CONVERSATIONS
      - IMPORT
      - INSTAGRAM_DM
      - FLOW
      - LIVE_CHAT
      - VKONTAKTE
      - ZALO_FOLLOWER
      - TIKTOK_BM
      - WHATSAPP
      - KAKAO_TALK
      - UNKNOWN
      example: API
      readOnly: true
      title: OriginV3
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionOperator:
      type: string
      description: The operators AFTER, BEFORE, and BETWEEN can be used to specify relative time periods, while their counterparts with the suffix _ABS (e.g., AFTER_ABS, BEFORE_ABS, BETWEEN_ABS) are used for absolute time values. These operators can be applied with start and end attributes to define the beginning and ending points of the time. Units need to be used with relative operators to specify the duration of the time periods.
      enum:
      - EMPTY
      - AFTER
      - BEFORE
      - BETWEEN
      - AFTER_ABS
      - BEFORE_ABS
      - BETWEEN_ABS
      example: BETWEEN
      title: TimelineConditionOperator
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Condition:
      type: object
      description: Defines how the 'condition' field is built, e.g., if 'SENDER', the condition is an object with an array of senders.
      title: Condition
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeContactInformationV3DocsSchema:
      type: object
      description: List of phones, emails and other information how a person can be contacted.
      properties:
        type:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ContactInformationTypeV3'
        identifier:
          type: string
          description: Person ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request. 255 characters max.
          example: '41793026727'
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Sender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max.
          example: '41793026728'
          maxLength: 255
          minLength: 0
        primary:
          type: boolean
          description: Indicates if this ID is preferred for communication. This flag only applies to PHONE and EMAIL.
          example: true
      title: MergeContactInformationV3DocsSchema
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OccurrenceConditionOperation:
      type: string
      description: Operation to compare how many times the event has occurred.
      enum:
      - IS
      - LESS_THAN
      - LESS_OR_EQUAL
      - GREATER_OR_EQUAL
      - GREATER_THAN
      example: IS
      title: OccurrenceConditionOperation
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowPersonRequest:
      type: object
      description: Contains the data used for person creation (if it does not exist) or partial update (if it exists)
      example:
        personData:
          externalId: '1'
          firstName: Jane
          lastName: Smith
          address: 67 Farringdon Road
          city: London
          country: United Kingdom
          gender: FEMALE
          birthDate: '1966-01-15'
          middleName: Janie
          profilePicture: http://profile.com
          tags:
          - VIP Customers
          - New Customers
          customAttributes:
            Contract Expiry: '2018-06-01'
            Company: Acme
          contactInformation:
            phone:
            - number: '41793026727'
            - number: '41793026728'
            email:
            - address: jane@acme.com
            - address: janesmith@acme.com
        flowVariables:
          orderDate: '2021-09-01'
          orderDetails: Extended Weight, Discount
          orderNumber: 1234567
      properties:
        personData:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPersonV2'
        flowVariables:
          type: object
          additionalProperties:
            type: object
      required:
      - personData
      title: FlowPersonRequest
    bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamGender:
      type: string
      enum:
      - MALE
      - FEMALE
      title: IamGender
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCode:
      type: string
      enum:
      - SUCCESS
      - ERROR
      title: StatusCode
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantResult:
      type: object
      description: Result of operation for the given participant.
      properties:
        identifyBy:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.WebhookPersonUniqueField'
        status:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantStatus'
        errorReason:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ErrorStatusReason'
      required:
      - identifyBy
      - status
      title: AddFlowParticipantResult
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowParticipantsReportResponse:
      type: object
      description: Summary of processing status for participants in a given operation.
      properties:
        operationId:
          type: string
          description: Unique identifier of the operation.
          example: 03f2d474-0508-46bf-9f3d-d8e2c28adaea
        campaignId:
          type: integer
          format: int64
          description: Unique identifier of the flow campaign.
          example: 200000000000001
        callbackData:
          type: string
          description: Additional data will be passed in the request to your callback server along with the operation results report.
        participants:
          type: array
          description: Array with information about each participant submitted for the operation.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantResult'
      required:
      - campaignId
      - operationId
      - participants
      title: FlowParticipantsReportResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagListItemResponse:
      type: object
      description: The list of the results for this page.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the tag.
          example: c56a4180-65aa-42ec-a945-5fd21dec0538
        name:
          type: string
          description: Name of the tag.
          example: sms
        referencesCount:
          type: integer
          format: int32
          description: Number of articles and attachments tagged with this tag.
          example: 8
        createdAt:
          type: string
          format: date-time
          description: Timestamp of when the tag was created.
          example: '2025-03-10T09:15:00Z'
        lastUpdatedAt:
          type: string
          format: date-time
          description: Timestamp of when the tag was last updated.
          example: '2025-06-15T14:20:00Z'
      required:
      - createdAt
      - id
      - lastUpdatedAt
      - name
      - referencesCount
      title: TagListItemResponse
    30bce31dfbdcb9fa9268f4e4ce1f7ccf05ef063a92c880be9d1b9efcfc2ac71a.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeSuccessResult:
      type: object
      description: Successful result for a person merge operation.
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the merged person profile.
        index:
          type: integer
          format: int32
          description: Index position of this person in the original request batch.
      title: MergeSuccessResult
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData:
      type: object
      description: User who uploaded the file.
      properties:
        encryptUserId:
          type: string
          description: Unique encrypted identifier of the user.
          example: a1b2c3d4e5f6
        firstName:
          type: string
          description: First name of the user.
          example: John
        lastName:
          type: string
          description: Last name of the user.
          example: Doe
      required:
      - encryptUserId
      - firstName
      - lastName
      title: UserData
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicOutboundMessage:
      type: object
      description: Received testing message.
      discriminator:
        propertyName: channel
        mapping:
          WHATSAPP: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.WhatsAppPublicOutboundMessage'
          CALLS: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.CallsPublicOutboundMessage'
          LIVE_CHAT: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.LiveChatPublicOutboundMessage'
      properties:
        channel:
          $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel'
      title: PublicOutboundMessage
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse:
      type: object
      properties:
        name:
          type: string
          description: Name of the tree node.
          example: Getting Started
        id:
          type: string
          format: uuid
          description: Unique identifier of the tree node.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        parentId:
          type: string
          format: uuid
          description: Identifier of the parent tree node.
          example: 1fa85f64-5717-4562-b3fc-2c963f66afa6
        articleCount:
          type: integer
          format: int32
          description: Number of articles in this node.
          example: 5
        position:
          type: integer
          format: int32
          description: Ordinal position of the node among siblings.
          example: 0
        type:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeType'
        hasChildren:
          type: boolean
          description: Whether this node has child nodes.
          example: true
        childList:
          type: array
          description: Child nodes of this tree node.
          items:
            $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse'
        scope:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope'
        source:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource'
        visibility:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility'
        root:
          type: boolean
          description: Whether this is a root node.
          example: false
      required:
      - articleCount
      - id
      - name
      - parentId
      - position
      - root
      - scope
      - type
      title: TreeNodeResponse
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Pagination:
      type: object
      properties:
        totalItems:
          type: integer
          format: int64
          readOnly: true
        page:
          type: integer
          format: int32
          readOnly: true
        limit:
          type: integer
          format: int32
          readOnly: true
        orderBy:
          type: string
          readOnly: true
      title: Pagination
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiRequest:
      type: object
      properties:
        name:
          type: string
          description: Waiting strategy name.
          maxLength: 128
          minLength: 1
        maximumWaitTime:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel'
        greetingMessage:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel'
        musicOnHold:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileAudioSourceApiModel'
        announcementMessage:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithPeriodicCollectApiModel'
        maximumWaitTimeMessage:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel'
        conditionType:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.ConditionType'
        condition:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Condition'
      required:
      - condition
      - conditionType
      - maximumWaitTime
      title: WaitingStrategyApiRequest
    1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.CDPWebhookReport:
      type: object
      discriminator:
        propertyName: type
        mapping:
          PERSON_ATTRIBUTE_CHANGED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.PersonAttributeChangedReport'
          PERSON_CONTACT_INFORMATION_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.PersonContactInformationUpdatedReport'
          PERSON_CONTACT_INFORMATION_CREATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.PersonContactInformationCreatedReport'
          PERSON_CONTACT_INFORMATION_DELETED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.PersonContactInformationDeletedReport'
          PERSON_MERGED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.PersonMergedReport'
          PERSON_CREATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.PersonCreatedReport'
          PERSON_DELETED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.PersonDeletedReport'
          PERSON_TAG_ADDED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.PersonTagAddedReport'
          PERSON_TAG_DELETED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.PersonTagRemovedReport'
          WEB_SDK_SESSION_STARTED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.WebSdkSessionStartedReport'
          WEB_SDK_SESSION_ENDED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.WebSdkSessionEndedReport'
          WEB_SDK_PAGE_VIEW: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.WebSdkPageViewReport'
          MOBILE_APP_PERSONALIZE: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.MobileAppPersonalizeReport'
          MOBILE_APP_DEPERSONALIZE: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.MobileAppDepersonalizeReport'
          MOBILE_APP_INSTALL: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.MobileAppInstallReport'
          MOBILE_APP_UNINSTALL: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.MobileAppUninstallReport'
          MOBILE_APP_APP_LAUNCH: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.MobileAppAppLaunchReport'
          PEOPLE_CUSTOM_AND_TEMPLATE_EVENTS: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.CustomEventReport'
      properties:
        type:
          type: string
          description: Defines the type of event being delivered.
        timestamp:
          type: string
          description: Date and time of the event.
          example: '2025-09-10T13:47:40.032+00:00'
      required:
      - timestamp
      - type
      title: CDPWebhookReport
    f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2:
      type: object
      properties:
        accountManager:
          type: string
          description: Account manager.
          maxLength: 255
          minLength: 0
          readOnly: false
          writeOnly: false
        country:
          type: string
          description: Country.
          maxLength: 50
          minLength: 0
          readOnly: false
          writeOnly: false
        createdAt:
          type: string
          description: 'Date and time of creation. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
          writeOnly: false
        customAttributes:
          type: object
          additionalProperties:
            type: object
          description: List of custom attributes for the company.
          readOnly: false
          writeOnly: false
        customerStage:
          type: string
          description: Customer stage.
          maxLength: 255
          minLength: 0
          readOnly: false
          writeOnly: false
        domains:
          type: array
          description: List of domains for the company.
          items:
            type: string
          readOnly: false
          writeOnly: false
        externalId:
          type: string
          description: Unique ID for a company from your or another external system, 256 characters max
          readOnly: false
          writeOnly: false
        id:
          type: integer
          format: int64
          description: Unique id of the entity.
          readOnly: true
          writeOnly: false
        industry:
          type: string
          description: Industry.
          maxLength: 255
          minLength: 0
          readOnly: false
          writeOnly: false
        modifiedAt:
          type: string
          description: 'Date and time of last modification. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
          writeOnly: false
        modifiedFrom:
          allOf:
          - $ref: '#/components/schemas/bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin'
          description: The information which describes the source of the last modification of record.
          readOnly: true
          writeOnly: false
        name:
          type: string
          description: Company name.
          maxLength: 255
          minLength: 0
          readOnly: false
          writeOnly: false
        notes:
          type: string
          description: Notes.
          maxLength: 1023
          minLength: 0
          readOnly: false
          writeOnly: false
        origin:
          allOf:
          - $ref: '#/components/schemas/bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin'
          description: The information which describes the origin of the record.
          readOnly: true
          writeOnly: false
        region:
          type: string
          description: Region.
          maxLength: 255
          minLength: 0
          readOnly: false
          writeOnly: false
        segment:
          type: string
          description: Segment.
          maxLength: 255
          minLength: 0
          readOnly: false
          writeOnly: false
        serviceData:
          type: object
          additionalProperties:
            type: object
          description: Company's service information.
          readOnly: false
          writeOnly: false
        tags:
          type: array
          description: List of tags for the company.
          items:
            type: string
          readOnly: false
          writeOnly: false
        vatNumber:
          type: string
          description: VAT number.
          maxLength: 50
          minLength: 0
          readOnly: false
          writeOnly: false
      required:
      - name
      title: IamCompanyV2
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentCreateUpdateRequest:
      type: object
      properties:
        content:
          type: string
          description: Content of the comment.
          example: Please review the second paragraph for accuracy.
          maxLength: 1000
          minLength: 0
      required:
      - content
      title: CommentCreateUpdateRequest
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsResponse:
      type: object
      description: An object containing specific information about an error.
      properties:
        index:
          type: integer
          format: int32
          description: The position of the entity in the request array that caused the error. An index of -1 indicates a general error not tied to a specific entity.
        code:
          type: integer
          format: int32
          description: A specific error code that categorizes the type of error, aiding in quick identification and resolution.
        message:
          type: string
          description: A descriptive message explaining the nature of the error.
        details:
          type: array
          description: An array providing additional context about specific aspects of the error.
          items:
            $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsItemResponse'
      required:
      - code
      - index
      - message
      title: ErrorDetailsResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus:
      type: string
      description: Workflow status of the article.
      enum:
      - PUBLISHED
      - DRAFT
      example: PUBLISHED
      title: WorkflowStatus
    ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationStatus:
      type: string
      description: Conversation status.
      enum:
      - OPEN
      - WAITING
      - SOLVED
      - CLOSED
      - PENDING
      title: ConversationStatus
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ActionAfterSubmissionType:
      type: string
      enum:
      - REDIRECT
      - MESSAGE
      title: ActionAfterSubmissionType
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorDetail:
      type: object
      description: Detailed error information for a specific property or field.
      properties:
        property:
          type: string
          description: Name of the property or field that caused the validation error.
        message:
          type: string
          description: Specific error message describing the validation failure.
        payload:
          type: object
          additionalProperties:
            type: object
          description: Additional context or metadata related to the validation error.
      title: ErrorDetail
    fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderField:
      type: string
      description: Field by which results should be ordered.
      enum:
      - DefinitionId
      - Title
      title: DefinitionOrderField
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonTypeV3:
      type: string
      description: Person's type, default type is CUSTOMER.
      enum:
      - CUSTOMER
      - LEAD
      example: CUSTOMER
      title: PersonTypeV3
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormField:
      type: object
      description: List of fields attached to a form
      properties:
        field:
          $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field'
        isRequired:
          type: boolean
          description: Is a field mandatory
        conditions:
          type: array
          description: List of conditions
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldCondition'
      title: FormField
    f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.ImportResponse:
      type: object
      example:
        resourceId: '12345'
      properties:
        resourceId:
          type: string
          description: SaaS resource identifier.
      required:
      - resourceId
      title: ImportResponse
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel:
      type: object
      example:
        agentId: 05261D01CC88F5A8C0C7C3A1EF74E430
        inbound: true
        outbound: true
        mediaType: AUDIO_AND_VIDEO
        useDefault: true
        enabled: false
        enabledChangedAt: 1622024333000
      properties:
        agentId:
          type: string
          description: ID of the agent to which the recording configuration belongs.
          readOnly: true
        inbound:
          type: boolean
          default: false
          description: 'Inbound record call direction enabled. At least one of the parameters ''inbound'' or ''outbound'' must be set to true. '
        outbound:
          type: boolean
          default: false
          description: 'Outbound record call direction enabled. At least one of the parameters ''inbound'' or ''outbound'' must be set to true. '
        mediaType:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.MediaTypeApiModel'
        useDefault:
          type: boolean
          default: false
          description: Use account recording config as default.
        enabled:
          type: boolean
          default: false
        enabledChangedAt:
          type: integer
          format: int64
          readOnly: true
      required:
      - agentId
      - mediaType
      title: AgentRecordingConfigApiModel
    d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResult:
      type: object
      properties:
        errors:
          type: array
          description: List of errors
          items:
            $ref: '#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError'
          readOnly: false
          writeOnly: false
        query:
          allOf:
          - $ref: '#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery'
        status:
          type: integer
          format: int32
          description: HTTP status
          readOnly: false
          writeOnly: false
      title: BatchDeleteResult
    61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPhoneContactV2:
      type: object
      properties:
        number:
          type: string
          description: Person's phone number. Must be in [international format](https://en.wikipedia.org/wiki/E.164) and cannot exceed 50 characters. One person can have up to 100 phone numbers.
          readOnly: false
          writeOnly: false
      title: IamPhoneContactV2
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldCondition:
      type: object
      description: List of conditions
      properties:
        id:
          type: string
          description: Id of the condition.
        value:
          type: string
          description: Condition value.
        fields:
          type: array
          description: List of fields to present if agent input matches condition value.
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.ConditionalField'
      title: FieldCondition
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateTagApiRequest:
      type: object
      example:
        name: Tag 1
      properties:
        name:
          type: string
          description: Tag name. Numbers, uppercase and lowercase letters, along with '.' and '_' characters are allowed!
          maxLength: 100
          minLength: 0
      required:
      - name
      title: CreateTagApiRequest
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageCatalogRecordListItemResponse:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CatalogRecordListItemResponse'
        paging:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo'
      required:
      - paging
      - results
      title: PageCatalogRecordListItemResponse
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PayloadConditionDto:
      type: object
      description: Specify the conditions of the event payload.
      properties:
        attribute:
          type: string
          description: Event payload attribute.
          example: itemId
        operator:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PayloadOperator'
        value:
          type: string
          description: Payload condition value.
          example: '10001'
      required:
      - attribute
      - operator
      - value
      title: PayloadConditionDto
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact:
      type: object
      description: A list of person's Kakao Sangdam destinations.
      properties:
        applicationId:
          type: string
          description: Application Id on which the user is subscribed.
          readOnly: true
        userId:
          type: string
          description: Unique user ID for a person.
          readOnly: true
        systemData:
          type: object
          additionalProperties:
            type: object
            readOnly: true
          description: System data collected from the user's profile.
          readOnly: true
      readOnly: true
      title: CommonOttContact
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageDirection:
      type: string
      description: Message direction
      enum:
      - INBOUND
      - OUTBOUND
      - INBOUND
      - OUTBOUND
      title: MessageDirection
    61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamEmailContactV2:
      type: object
      properties:
        address:
          type: string
          description: Person's email address. Must comply with the [email format](https://tools.ietf.org/html/rfc2822) and cannot exceed 255 characters. One person can have up to 100 email addresses.
          readOnly: false
          writeOnly: false
      title: IamEmailContactV2
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentListItemResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the comment.
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        content:
          type: string
          description: Content of the comment.
          example: Please review the second paragraph for accuracy.
        createdAt:
          type: string
          format: date-time
          description: Timestamp of when the comment was created.
          example: '2025-06-15T10:30:00Z'
        createdBy:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData'
        lastUpdatedAt:
          type: string
          format: date-time
          description: Timestamp of when the comment was last updated.
          example: '2025-06-15T14:20:00Z'
        resolved:
          type: boolean
          description: Whether the comment is resolved.
          example: false
        lastSolver:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData'
        lastResolvedAt:
          type: string
          format: date-time
          description: Timestamp of when the comment was last resolved or unresolved.
          example: '2025-06-16T09:00:00Z'
        lastContentUpdatedAt:
          type: string
          format: date-time
          description: Timestamp of when the comment content was last updated.
          example: '2025-06-15T14:20:00Z'
        lastContentUpdatedBy:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData'
      required:
      - content
      - createdAt
      - createdBy
      - id
      - lastContentUpdatedAt
      - lastContentUpdatedBy
      - lastUpdatedAt
      - resolved
      title: CommentListItemResponse
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.ConditionType:
      type: string
      description: Defines which waiting strategy entity the condition applies to. Once defined, cannot be changed.
      enum:
      - SENDER
      - QUEUE
      title: ConditionType
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationEmail:
      type: object
      properties:
        address:
          type: string
      title: ContactInformationEmail
    25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse:
      type: object
      example:
        id: 07ad4193-4354-488c-b45f-293dfa4c90fb
        timezone: Etc/UTC
        message: We're out of office, come back another time, thank you!
        workWeek:
          MONDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          TUESDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          WEDNESDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          THURSDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          FRIDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          SATURDAY:
            startTime: 0
            endTime: 1440
            enabled: true
          SUNDAY:
            startTime: 0
            endTime: 1440
            enabled: true
        name: My Working Hours
        enabled: true
        isDefault: true
        closeConversations: false
        holidays:
        - id: aae9b06f-a323-4c9c-b807-7a9e4e015405
          workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
          name: New Year's Day
          startDate: '2021-01-01'
          endDate: '2021-01-01'
          enabled: true
        - id: 6bfb9b10-caec-4f53-85a9-b87da6afa88f
          workingHoursId: 07ad4193-4354-488c-b45f-293dfa4c90fb
          name: My Holiday
          startDate: '2021-06-09'
          endDate: '2021-06-09'
          enabled: false
      properties:
        id:
          type: string
          description: Working hours Id.
          readOnly: true
        timezone:
          type: string
          description: 'Timezone in which working hours apply.

            `TZ database name` from [IANA time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)'
        message:
          type: string
          description: Message to be sent as an auto-reply message to the customer.
        workWeek:
          type: object
          description: 'List of working hours work days.

            It must contain all days of the week with 3 parameters each: `startTime`, `endTime` and `enabled`.'
          enum:
          - MONDAY
          - TUESDAY
          - WEDNESDAY
          - THURSDAY
          - FRIDAY
          - SATURDAY
          - SUNDAY
          properties:
            startTime:
              type: integer
              format: int32
              description: Start time of the day in minutes after midnight.
              maximum: 1440
              minimum: 0
            endTime:
              type: integer
              format: int32
              description: End time of the day in minutes before midnight.
              maximum: 1440
              minimum: 0
            enabled:
              type: boolean
              description: Daily working hours enable/disable toggle.
        name:
          type: string
          description: Working hours name.
        enabled:
          type: boolean
          description: Working hours enable/disable toggle.
        isDefault:
          type: boolean
          description: Default working hours.
        closeConversations:
          type: boolean
          description: Close conversation created outside of working hours toggle.
        sendAwayMessageEveryOOWHPeriod:
          type: boolean
        holidays:
          type: array
          description: List of working hours holidays.
          items:
            $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.HolidaysApiModel'
          uniqueItems: true
      required:
      - message
      - name
      - timezone
      title: WorkingHoursApiResponse
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateMessageApiRequest:
      type: object
      properties:
        channel:
          type: string
          description: Available communication channels
          enum:
          - SMS
          - VIBER
          - FACEBOOK_MESSENGER
          - WHATSAPP
          - RCS
          - LIVE_CHAT
          - LINE
          - APPLE_BUSINESS_CHAT
          - EMAIL
          - TELEGRAM
          - INSTAGRAM_MESSAGING
          - KAKAO_SANGDAM
          - VIBER_BOT
        from:
          type: string
          description: Sender phone number, email address, FB messenger Id or live chat widget Id.
        to:
          type: string
          description: Destination phone number, email address, FB messenger or live chat user Id.
        content:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageContent'
        contentType:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType'
      required:
      - channel
      - content
      - contentType
      - from
      - to
      title: CreateMessageApiRequest
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageResultPage:
      type: object
      example:
        messages:
        - id: c3b94b2f-a3a1-4999-b63b-413800544123
          from: '447492263899'
          to: '447496389711'
          channel: SMS
          direction: INBOUND
          conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          contentType: TEXT
          content:
            text: Customer message content
        - id: 0224bdbc-8693-4ce5-8eb1-c8046d44d09f
          from: '447492263899'
          to: '447496389711'
          channel: VIBER
          direction: OUTBOUND
          conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          contentType: TEXT
          content:
            text: Agent message content
        pagination:
          totalItems: 2
          page: 0
          limit: 10
          orderBy: id:ASC
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageApiResponse'
        pagination:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination'
      title: MessageResultPage
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form:
      type: object
      properties:
        id:
          type: string
          description: Form id.
        title:
          type: string
          description: Form title.
        isEnabled:
          type: boolean
          description: Is form enabled.
        isDefault:
          type: boolean
          description: Is form marked as default one.
        fields:
          type: array
          description: List of fields attached to a form
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormField'
        createdAt:
          type: string
        updatedAt:
          type: string
      title: Form
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.LeaderboardResponse:
      type: object
      properties:
        scores:
          type: array
          description: List of scores for the leaderboard.
          items:
            $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.LeaderboardEntry'
          title: Scores
        paging:
          $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.PagingInfo'
          description: Paging information for the leaderboard response.
      required:
      - paging
      - scores
      title: LeaderboardResponse
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageSegmentResponseDto:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto'
        paging:
          $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageInfo'
      required:
      - paging
      - results
      title: PageSegmentResponseDto
    c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse:
      type: object
      properties:
        results:
          type: array
          description: List of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists.
          items:
            $ref: '#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResult'
          readOnly: false
          writeOnly: false
      title: BatchCreateResponse
    a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamSalesforceV2:
      type: object
      properties:
        contactId:
          type: string
          description: Salesforce contact id.
          readOnly: false
          writeOnly: false
        leadId:
          type: string
          description: Salesforce lead id.
          readOnly: false
          writeOnly: false
      title: IamSalesforceV2
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalRequest:
      type: object
      example:
        externalNumber: '41792036727'
        from: '41793026834'
      properties:
        externalNumber:
          type: string
          description: Valid phone number in the E.164 format to which a call should be transferred.
          example: '41792036727'
        from:
          type: string
          description: Caller identifier. Must be a phone number in the E.164 format
          example: '41793026834'
      title: TransferToExternalRequest
    62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteRequest:
      type: object
      properties:
        companies:
          type: array
          description: List of companies.
          items:
            $ref: '#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteEntry'
          readOnly: false
          writeOnly: false
      title: BatchDeleteRequest
    a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2:
      type: object
      properties:
        address:
          type: string
          description: Person's address, 256 characters max.
          readOnly: false
          writeOnly: false
        birthDate:
          type: string
          description: Person's date of birth, format `YYYY-MM-DD`.
          readOnly: false
          writeOnly: false
        city:
          type: string
          description: Person's city, 50 characters max.
          readOnly: false
          writeOnly: false
        computedAttributes:
          type: object
          additionalProperties:
            type: object
          description: Person's computed attributes grouped by type.
          readOnly: true
          writeOnly: false
        contactInformation:
          allOf:
          - $ref: '#/components/schemas/61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPersonContactsV2'
          description: List of phones, emails and other information how a person can be contacted.
          readOnly: false
          writeOnly: false
        country:
          type: string
          description: Person's country, 50 characters max.
          readOnly: false
          writeOnly: false
        createdAt:
          type: string
          description: 'Date and time of creation. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
          writeOnly: false
        customAttributes:
          type: object
          additionalProperties:
            type: object
          description: List of custom attributes for the person, 4096 characters max per value.
          readOnly: false
          writeOnly: false
        externalId:
          type: string
          description: Unique ID for a person from your or another external system, 256 characters max.
          readOnly: false
          writeOnly: false
        firstName:
          type: string
          description: Person's first name, 255 characters max.
          readOnly: false
          writeOnly: false
        gender:
          allOf:
          - $ref: '#/components/schemas/bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamGender'
          description: Person's gender.
          readOnly: false
          writeOnly: false
        id:
          type: integer
          format: int64
          description: Unique id of the entity.
          readOnly: true
          writeOnly: false
        integrations:
          allOf:
          - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamIntegrationsV2'
          description: Integrations.
          readOnly: true
          writeOnly: false
        lastName:
          type: string
          description: Person's last name, 255 characters max.
          readOnly: false
          writeOnly: false
        middleName:
          type: string
          description: Person's middle name, 50 characters max.
          readOnly: false
          writeOnly: false
        modifiedAt:
          type: string
          description: 'Date and time of last modification. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
          writeOnly: false
        modifiedFrom:
          allOf:
          - $ref: '#/components/schemas/bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin'
          description: The information which describes the source of the last modification of record.
          readOnly: true
          writeOnly: false
        origin:
          allOf:
          - $ref: '#/components/schemas/bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin'
          description: The information which describes the origin of the record.
          readOnly: true
          writeOnly: false
        preferredLanguage:
          type: string
          description: Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.
          readOnly: false
          writeOnly: false
        profilePicture:
          type: string
          description: URL for the person's profile picture, 2083 characters max.
          readOnly: false
          writeOnly: false
        tags:
          type: array
          description: List of tags that this person has.
          items:
            type: string
          readOnly: false
          writeOnly: false
        type:
          allOf:
          - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamTypeV2'
          description: Person's type, default type is CUSTOMER.
          readOnly: false
          writeOnly: false
      title: IamPersonV2
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.FolderItemResponse:
      type: object
      description: The list of the results for this page.
      properties:
        name:
          type: string
          description: Name of the folder.
          example: Getting Started
        id:
          type: string
          format: uuid
          description: Unique identifier of the folder.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        breadCrumbList:
          type: array
          description: Breadcrumb path from root to this folder.
          example:
          - API Guides
          - SMS
          - Getting Started
          items:
            type: string
            description: Breadcrumb path from root to this folder.
            example: '["API Guides","SMS","Getting Started"]'
      required:
      - breadCrumbList
      - id
      - name
      title: FolderItemResponse
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertPersonV3DocsSchema:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique id of the entity.
          example: 1
          readOnly: true
        externalId:
          type: string
          description: Unique ID for a person from your or another external system, 256 characters max.
          example: '3'
          maxLength: 256
          minLength: 0
        type:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonTypeV3'
        firstName:
          type: string
          description: Person's first name, 255 characters max.
          example: Jane
          maxLength: 255
          minLength: 0
        middleName:
          type: string
          description: Person's middle name, 50 characters max.
          example: Janie
          maxLength: 50
          minLength: 0
        lastName:
          type: string
          description: Person's last name, 255 characters max.
          example: Smith
          maxLength: 255
          minLength: 0
        nickName:
          type: string
          description: Person's nick name, 50 characters max.
          example: Janey
          maxLength: 50
          minLength: 0
        country:
          type: string
          description: Person's country, 50 characters max.
          example: United Kingdom
          maxLength: 50
          minLength: 0
        city:
          type: string
          description: Person's city, 50 characters max.
          example: London
          maxLength: 50
          minLength: 0
        address:
          type: string
          description: Person's address, 256 characters max.
          example: 67 Farringdon Road
          maxLength: 256
          minLength: 0
        gender:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonGenderV3'
        preferredLanguage:
          type: string
          description: Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.
          example: en-gb
        birthDate:
          type: string
          format: date
          description: Person's date of birth, format `YYYY-MM-DD`.
          example: '1966-01-15'
        profilePicture:
          type: string
          format: url
          description: URL for the person's profile picture, 2083 characters max.
          example: http://profile.com
          maxLength: 2083
          minLength: 0
        tags:
          type: array
          description: List of tags that this person has.
          example:
          - tag1
          - tag2
          items:
            type: string
            description: List of tags that this person has.
            example: '["tag1","tag2"]'
          uniqueItems: true
        contactInformation:
          type: array
          description: List of phones, emails and other information how a person can be contacted.
          items:
            $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertContactInformationV3DocsSchema'
        customAttributes:
          type: object
          additionalProperties:
            type: object
            example:
              Contract Expiry: '2024-06-12'
              Company: ACME
          description: List of custom attributes for the person, 4096 characters max per value.
          example:
            Contract Expiry: '2024-06-12'
            Company: ACME
        computedAttributes:
          type: object
          additionalProperties:
            type: object
            example:
              fullName: Jane Smith
            readOnly: true
          description: Person's computed attributes grouped by type.
          example:
            fullName: Jane Smith
          readOnly: true
        createdFrom:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3'
        createdBy:
          type: string
          description: Identifier of the user who created this person record.
          example: '5'
          readOnly: true
        createdAt:
          type: string
          format: date-time
          description: 'Date and time of creation. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
        modifiedFrom:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3'
        modifiedBy:
          type: string
          description: Identifier of the user who last modified this person record.
          example: '5'
          readOnly: true
        modifiedAt:
          type: string
          format: date-time
          description: 'Date and time of last modification. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
      title: UpsertPersonV3DocsSchema
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.BackgroundBlurSettingsApiModel:
      type: object
      description: Configuration for the background display while the agent is on a call. <a href="https://www.infobip.com/docs/conversations/calls#background-options-for-video-calls-agent-guide" target="_blank">More info</a>.
      properties:
        mode:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VideoFilterModeApiModel'
        fileMetadata:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.BackgroundFileMetadataApiModel'
      required:
      - mode
      title: BackgroundBlurSettingsApiModel
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ListItemFieldResource:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          description: Field name within a List item. Must not exceed `128` characters. Must start with a lowercase letter `(a–z)` and can contain alphanumeric characters `(A–Z, a–z, 0–9)` and underscores `(_)`.
          maxLength: 128
          minLength: 1
          pattern: ^[a-z_][a-zA-Z0-9_]*$
        type:
          allOf:
          - $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.ListItemFieldType'
          description: 'Field data type within a List item.<br>**Note**: `List` type is not allowed for nested fields.'
          minLength: 1
      required:
      - name
      - type
      title: ListItemFieldResource
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormStatus:
      type: string
      description: Form status
      enum:
      - ACTIVE
      - DISABLED
      - DRAFT
      title: FormStatus
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.PublicIamTypeV2:
      type: string
      description: Person's type, default type is CUSTOMER.
      enum:
      - CUSTOMER
      - LEAD
      title: PublicIamTypeV2
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventApiRequest:
      type: object
      properties:
        from:
          type: string
          description: Sender Id.
        to:
          type: string
          description: Destination Id.
        type:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventType'
        channel:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventChannel'
      required:
      - channel
      - from
      - to
      - type
      title: ConversationEventApiRequest
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel:
      type: object
      description: File audio source or TTS audio source information.
      properties:
        enabled:
          type: boolean
        Audio source type:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AudioSourceTypeApiModel'
        ttsAudioSource:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsAudioSourceApiModel'
        fileAudioSource:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel'
      title: OptionWithFileOrTtsAudioSourceApiModel
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventType:
      type: string
      description: Event type.
      enum:
      - TYPING_STARTED
      - TYPING_STOPPED
      title: ConversationEventType
    b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact:
      type: object
      properties:
        applicationId:
          type: string
          description: Application Id on which the user is subscribed.
          readOnly: true
          writeOnly: false
        systemData:
          type: object
          additionalProperties:
            type: object
          description: System data collected from the user's profile.
          readOnly: true
          writeOnly: false
        userId:
          type: string
          description: Unique user ID for a person.
          readOnly: true
          writeOnly: false
      title: CommonOttContact
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageFolderItemResponse:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.FolderItemResponse'
        paging:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo'
      required:
      - paging
      - results
      title: PageFolderItemResponse
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorCodeV3:
      type: string
      description: Error code identifying the type of error that occurred.
      enum:
      - '400100'
      - '400101'
      - '400102'
      - '400103'
      - '400104'
      - '400105'
      - '400106'
      - '400107'
      - '404100'
      - '404101'
      - '405100'
      - '409100'
      - '500100'
      title: ErrorCodeV3
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventFieldResource:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          description: Field name. Must not exceed `128` characters. Must start with a lowercase letter `(a–z)` and can contain alphanumeric characters `(A–Z, a–z, 0–9)` and underscores `(_)`.
          maxLength: 128
          minLength: 1
          pattern: ^[a-z_][a-zA-Z0-9_]*$
        type:
          allOf:
          - $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventFieldType'
          description: Field data type.
          minLength: 1
        schema:
          allOf:
          - $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ListItemResource'
          description: Schema definition for List type fields. Must be `null` when type is not `List`. Must be provided and valid when type equals `List`.
      required:
      - name
      - type
      title: EventFieldResource
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteApiResponse:
      type: object
      example:
        agentId: 1367466e-7e5d-40d7-a78a-ace2780ed3dd
        content: Sample Note content
      properties:
        id:
          type: string
          description: Note Id
        conversationId:
          type: string
          description: Id of the conversation holding the note.
        agentId:
          type: string
          description: Id of the author agent.
        content:
          type: string
          description: Note content, which can be any text up to 4000 characters.
        type:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteType'
        createdAt:
          type: string
          format: date-time
          description: Time stamp when note is created.
        updatedAt:
          type: string
          format: date-time
          description: Time stamp when note is updated.
      title: NoteApiResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope:
      type: string
      description: Content scope of the node.
      enum:
      - INTERNAL
      - EXTERNAL
      example: INTERNAL
      title: ContentScope
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigWrapUpApiModel:
      type: object
      example:
        wrapUpSeconds: 30
      properties:
        wrapUpSeconds:
          type:
          - integer
          - 'null'
          format: int32
          description: Wrap up length in seconds specific to the agent. Null if not set, in which case account wrap up time should be used. <a href="https://www.infobip.com/docs/conversations/calls#wrap-up-window-agent-guide" target="_blank">More info</a>.
      title: AgentConfigWrapUpApiModel
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchAmgModel:
      type: object
      description: List of matches.
      properties:
        personId:
          type: integer
          format: int64
          description: Person's internal ID.
        type:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType'
        identifier:
          type: string
          description: Person ID
        sender:
          type: string
          description: Sender or application ID.
      title: MatchAmgModel
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource:
      type: object
      additionalProperties: false
      properties:
        templateId:
          type:
          - string
          - 'null'
          description: 'Template identifier. Used when the client wants to create a definition from a template. Must contain only alphanumeric characters `(a–z, A–Z, 0–9)`. Maximum length: `36` characters. Must be `null` if `definitionId` is provided.'
          pattern: ^[a-zA-Z0-9]{0,36}$
        definitionId:
          type:
          - string
          - 'null'
          description: 'Event definition identifier. Must contain only alphanumeric characters `(a–z, A–Z, 0–9)`. Maximum length: `36` characters. Must be `null` if `templateId` is provided. Cannot have a value from the list of predefined (standard) definitions.'
          pattern: ^[a-zA-Z0-9]{0,36}$
        title:
          type:
          - string
          - 'null'
          description: 'Event definition title. Required if `templateId` is `null`. Maximum length: `100` characters. Must be `null` if `templateId` is provided.'
        description:
          type:
          - string
          - 'null'
          description: 'Event definition description. Maximum length: `2000` characters if `templateId` is `null`. Must be `null` if `templateId` is provided.'
        fields:
          type:
          - array
          - 'null'
          description: Event definition fields. The total number of fields cannot exceed `120`. Field names must be unique (case-insensitive). The number of fields of type `List` cannot exceed `1`.
          items:
            $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventFieldResource'
          maxItems: 120
          uniqueItems: true
      title: EventDefinitionCreateResource
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance:
      type: object
      properties:
        registrationId:
          type: string
          description: Push registration id of the instance
          readOnly: true
        applicationId:
          type: string
          description: String id of the application that the instance belongs to
          readOnly: true
        isPrimary:
          type: boolean
          description: Set to `true` if this device is a primary device of a user among other devices
        additionalData:
          type: object
          additionalProperties:
            type: object
          description: Custom attributes set for a device
        systemData:
          $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstanceSystemData'
      required:
      - applicationId
      - registrationId
      title: PushApiInstance
    a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.RequestStatus:
      type: string
      description: Status of the data export request.
      enum:
      - SUBMITTED
      - IN_PROGRESS
      - COMPLETED_SUCCESSFULLY
      - FAILED_AWAITING_RETRY
      - FAILED_AFTER_MAX_RETRIES
      - CANCELLED_BY_CUSTOMER
      readOnly: true
      title: RequestStatus
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RoutingRulesResultPage:
      type: object
      example:
        routes:
        - id: 467bbaad-3f50-4c27-9f24-0427aaec611f
          priority: URGENT
          queueId: 448bf76d-0047-49a3-93a4-ea8722d6aeaa
          queueName: First Queue
          enabled: true
          name: First Rule
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          order: 1
          routeOnlyDuringWorkingHours: true
          isPrivate: false
          expression:
            $or:
            - $eq:
                message.channel: WHATSAPP
            - $eq:
                message.channel: LIVE_CHAT
        - id: 467bbaad-3f50-4c27-9f24-0427baec611f
          priority: HIGH
          queueId: 448bf76d-0047-49a3-93a4-ea8722d7aeab
          queueName: Second Queue
          enabled: true
          name: Second Rule
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          order: 2
          routeOnlyDuringWorkingHours: false
          isPrivate: false
          expression:
            $and:
            - $eq:
                message.channel: TELEGRAM
            - $eq:
                customer.country: Croatia
        - id: eb7bdb7d-7281-4107-8d7b-80efc8548a38
          priority: NORMAL
          queueId: 39b52b7f-db13-4c47-9b6e-de2ba91df62g
          queueName: Third Queue
          enabled: true
          name: Third Rule
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          order: 3
          routeOnlyDuringWorkingHours: false
          isPrivate: false
          expression:
            $eq:
              message.channel: VIBER
        pagination:
          totalItems: 3
          page: 0
          limit: 999
          orderBy: order:ASC
      properties:
        routes:
          type: array
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RuleApiResponse'
        pagination:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination'
      title: RoutingRulesResultPage
    08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest:
      type: object
      properties:
        contactInformation:
          allOf:
          - $ref: '#/components/schemas/61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPersonContactsV2'
          description: Person's contact information
          readOnly: false
          writeOnly: false
      required:
      - contactInformation
      title: PersonDestinationRequest
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigApiModel:
      type: object
      properties:
        backgroundBlurSettings:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.BackgroundBlurSettingsApiModel'
        wrapUpSeconds:
          type: integer
          format: int32
          description: Wrap up length in seconds specific to the agent. Null if not set, in which case account wrap up time should be used. <a href="https://www.infobip.com/docs/conversations/calls#wrap-up-window-agent-guide" target="_blank">More info</a>.
      title: AgentConfigApiModel
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.GetPlaceholdersApiResponse:
      type: object
      example:
        type: POSITION_IN_QUEUE
        sayAs: DEFAULT
        placeholderValue: '{{QUEUE_POSITION_DEFAULT}}'
        placeholderPaddingSize: 20
        requiresSSML: false
      properties:
        type:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPlaceholderTypeApiModel'
        sayAs:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPlaceholderSayAsApiModel'
        placeholderValue:
          type: string
          description: "Value to be placed in TTS text field which will be resolved in runtime to an actual value. This value is used to identify the placeholder.\n For example, {{QUEUE_POSITION_DEFAULT}} is a placeholder for the position in the queue with DEFAULT sayAs option.\n Here is example Text-to-Speech text: \"You are {{QUEUE_POSITION_DEFAULT}} in the queue.\"\n"
        placeholderPaddingSize:
          type: integer
          format: int32
          description: "Specifies how many characters will be added by the system in the background to correctly resolve the placeholder.\n This number is added to current TTS text length and counts toward max TTS text length.\n"
        requiresSSML:
          type: boolean
          description: Specifies whether this placeholder requires TTS voice to support SSML.
      title: GetPlaceholdersApiResponse
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignCreatePayload:
      type: object
      properties:
        name:
          type: string
          description: Name of the campaign. Must be unique per account.
          examples:
          - My Campaign
          title: Name
        keywordSpec:
          type: object
          additionalProperties:
            type: string
          description: 'Specification of language-specific key phrases that users should pronounce during the campaign. This is a dictionary mapping language codes (ISO 639-1 with optional country code, e.g., ''en-US'', ''es-ES'') to the exact phrases users must say. Find the list of languages supported by Azure <a href="https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt">here</a> and the list of languages supported by Google <a href="https://cloud.google.com/speech-to-text/docs/speech-to-text-supported-languages">here</a>. The speech-to-text engine will compare user audio against these phrases for scoring. If left unspecified, the campaign will rely solely on image and/or audio matching. Phrases should be clear, pronounceable words or short sentences in the target language. '
          examples:
          - en-US: Hello
            es-ES: Hola
          title: Keywordspec
        activeFrom:
          type: string
          format: date-time
          description: Date and time when the campaign becomes active, in ISO 8601 format (e.g., 2023-10-01T00:00:00Z).
          title: Activefrom
        activeUntil:
          type: string
          format: date-time
          description: Date and time when the campaign ends, in ISO 8601 format (e.g., 2023-10-31T23:59:59Z).
          title: Activeuntil
        settings:
          $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignSettings'
          default:
            maxDailyAttemptsPerUser: 30
            sttModelProvider: AZURE
            maxDailyAttemptsPerCampaign: 1500
          description: Campaign settings. You can regulate the number of attempts per user daily, as well as the total number of attempts in the campaign daily.
        imageUrl:
          type: string
          description: Image used for shape matching.
          examples:
          - https://www.example.com/image.jpg
          title: Imageurl
      required:
      - activeFrom
      - activeUntil
      - name
      title: CampaignCreatePayload
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversation:
      type: object
      description: A pair of linked conversations.
      example:
        parentConversation:
          conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          agentId: c856e230-a8cd-498b-9996-42bbed35029a
          topic: Billing inquiry
          channel: WHATSAPP
          status: OPEN
          customerDisplayName: John Doe
        childConversation:
          conversationId: e43bc422-09c9-4591-8b9d-82debcf04e0d
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          agentId: c856e230-a8cd-498b-9996-42bbed35029a
          topic: Follow-up
          channel: LIVE_CHAT
          status: OPEN
          customerDisplayName: John Doe
      properties:
        parentConversation:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversationMember'
        childConversation:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversationMember'
      required:
      - childConversation
      - parentConversation
      title: LinkedConversation
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination:
      type: object
      properties:
        totalItems:
          type: integer
          format: int64
          readOnly: true
        page:
          type: integer
          format: int32
          readOnly: true
        limit:
          type: integer
          format: int32
          readOnly: true
        orderBy:
          type: string
          readOnly: true
      title: Pagination
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateResultPage:
      type: object
      example:
        templates:
        - id: c4391685-b21a-4c21-a470-5453e9382752
          name: First template name
          language: English
          languageCode: en
          channel: SMS
          external: false
          content: Simple English text content
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          tags:
          - name: First template tag
            createdAt: '2024-01-01T00:00:00.000+00:00'
            updatedAt: '2024-01-01T00:00:00.000+00:00'
          attachments: []
        - id: e2fafe40-ea15-49c8-ae9b-aa07131a0096
          name: Second template name
          language: Spanish
          languageCode: es
          channel: SMS
          external: false
          content: Simple Spanish text content
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          tags:
          - name: Second template tag
            createdAt: '2024-01-01T00:00:00.000+00:00'
            updatedAt: '2024-01-01T00:00:00.000+00:00'
          attachments:
          - id: e2fafe40-ea15-49c8-ae9b-aa07131a0096
            fileName: Second template file
            fileExtension: txt
            fileSize: 1024
            contentType: text/plain
            publicLink: https://example.com/second-template-file.txt
            thumbLink: https://example.com/second-template-file-thumb.png
            uploadedAt: '2024-01-01T00:00:00.000+00:00'
          - id: e2fafe40-ea15-49c8-ae9b-aa07131a0096
            fileName: Second template image
            fileExtension: png
            fileSize: 2048
            contentType: image/png
            publicLink: https://example.com/second-template-image.png
            thumbLink: https://example.com/second-template-image-thumb.png
            uploadedAt: '2024-01-01T00:00:00.000+00:00'
        pagination:
          totalItems: 2
          page: 0
          limit: 10
          orderBy: createdAt:DESC
      properties:
        templates:
          type: array
          description: List of templates.
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateApiResponse'
        pagination:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination'
      title: TemplateResultPage
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UpdateArticleStatusRequest:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus'
      required:
      - status
      title: UpdateArticleStatusRequest
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ErrorStatusReason:
      type: string
      description: '

        Detailed reason for the REJECTED status:

        * `REJECTED_INVALID_CONTACT` - Person started to be processed but has been rejected as the contact is not recognized.

        * `REJECTED_ATTRIBUTE_MISSED` - One of the person''s attributes specified in the request does not exist or has spelling error.

        * `REJECTED_PERSON_ALREADY_IN_FLOW` - Person is already in flow.

        * `REJECTED_PERSON_NOT_ALLOWED_TO_REENTER` - Person is not allowed to re-enter flow now.

        * `REJECTED_FLOW_ERROR_UNKNOWN` - Generic flow error.

        * `REJECTED_NOT_ENOUGH_CREDITS` - Your account is out of credits for further submission. Top up your account. For further assistance in topping up or applying for an online account top-up service, you may contact your Account Manager.

        '
      enum:
      - REJECTED_INVALID_CONTACT
      - REJECTED_ATTRIBUTE_MISSED
      - REJECTED_PERSON_IN_FLOW
      - REJECTED_PERSON_NOT_ALLOWED_TO_REENTER
      - REJECTED_FLOW_ERROR_UNKNOWN
      - REJECTED_NOT_ENOUGH_CREDITS
      - REJECTED_CDP_ERROR_UNKNOWN
      title: ErrorStatusReason
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiStatusResponse:
      type: object
      properties:
        status:
          type: string
      required:
      - status
      title: ApiStatusResponse
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonGenderV3:
      type: string
      description: Person's gender.
      enum:
      - MALE
      - FEMALE
      example: FEMALE
      title: PersonGenderV3
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToAgentRequest:
      type: object
      example:
        agentId: 3791078D92DF1FA5DE5F703345153GA2
      properties:
        agentId:
          type: string
          description: Id of the agent to whom a call should be transferred.
          example: 3791078D92DF1FA5DE5F703345153GA2
      title: TransferToAgentRequest
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantStatus:
      type: string
      description: Processing status of the participant.
      enum:
      - PENDING
      - REJECTED
      - ACCEPTED
      title: AddFlowParticipantStatus
    d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteEntry:
      type: object
      properties:
        query:
          allOf:
          - $ref: '#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery'
      title: BatchDeleteEntry
    ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResult:
      type: object
      properties:
        errors:
          type: array
          description: List of errors
          items:
            $ref: '#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError'
          readOnly: false
          writeOnly: false
        query:
          type: object
          additionalProperties:
            type: object
          description: Query used for company identification
          readOnly: false
          writeOnly: false
        status:
          type: integer
          format: int32
          description: HTTP status
          readOnly: false
          writeOnly: false
      title: BatchUpdateResult
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.Channel:
      type: string
      description: Channel through which the score is submitted, e.g., 'WHATSAPP', 'WEB', etc.
      enum:
      - WHATSAPP
      - RCS
      - WEB
      - UNKNOWN
      title: Channel
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreResponse:
      type: object
      properties:
        score:
          $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreReturn'
          description: The score data including all scoring details and best score for the participant.
        stats:
          $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreStats'
          description: Statistical information about the participant's performance and ranking in the campaign.
      required:
      - score
      - stats
      title: ScoreResponse
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.PagingInfo:
      type: object
      properties:
        page:
          type: integer
          default: 0
          description: Page number.
          minimum: 0
          title: Page
        size:
          type: integer
          default: 10
          description: Number of records per page.
          exclusiveMinimum: 0
          maximum: 100
          title: Size
        totalPages:
          type: integer
          description: Total number of pages available based on the total number of records and page size.
          title: Totalpages
        totalResults:
          type: integer
          description: Total number of records available across all pages.
          title: Totalresults
      required:
      - totalPages
      - totalResults
      title: PagingInfo
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergePersonV3DocsSchema:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique id of the entity.
          example: 1
          readOnly: true
        externalId:
          type: string
          description: Unique ID for a person from your or another external system, 256 characters max.
          example: '3'
          maxLength: 256
          minLength: 0
        type:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonTypeV3'
        firstName:
          type: string
          description: Person's first name, 255 characters max.
          example: Jane
          maxLength: 255
          minLength: 0
        middleName:
          type: string
          description: Person's middle name, 50 characters max.
          example: Janie
          maxLength: 50
          minLength: 0
        lastName:
          type: string
          description: Person's last name, 255 characters max.
          example: Smith
          maxLength: 255
          minLength: 0
        nickName:
          type: string
          description: Person's nick name, 50 characters max.
          example: Janey
          maxLength: 50
          minLength: 0
        country:
          type: string
          description: Person's country, 50 characters max.
          example: United Kingdom
          maxLength: 50
          minLength: 0
        city:
          type: string
          description: Person's city, 50 characters max.
          example: London
          maxLength: 50
          minLength: 0
        address:
          type: string
          description: Person's address, 256 characters max.
          example: 67 Farringdon Road
          maxLength: 256
          minLength: 0
        gender:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonGenderV3'
        preferredLanguage:
          type: string
          description: Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.
          example: en-gb
        birthDate:
          type: string
          format: date
          description: Person's date of birth, format `YYYY-MM-DD`.
          example: '1966-01-15'
        profilePicture:
          type: string
          format: url
          description: URL for the person's profile picture, 2083 characters max.
          example: http://profile.com
          maxLength: 2083
          minLength: 0
        tags:
          type: array
          description: List of tags that this person has.
          example:
          - tag1
          - tag2
          items:
            type: string
            description: List of tags that this person has.
            example: '["tag1","tag2"]'
          uniqueItems: true
        contactInformation:
          type: array
          description: List of phones, emails and other information how a person can be contacted.
          items:
            $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeContactInformationV3DocsSchema'
        customAttributes:
          type: object
          additionalProperties:
            type: object
            example:
              Contract Expiry: '2024-06-12'
              Company: ACME
          description: List of custom attributes for the person, 4096 characters max per value.
          example:
            Contract Expiry: '2024-06-12'
            Company: ACME
        computedAttributes:
          type: object
          additionalProperties:
            type: object
            example:
              fullName: Jane Smith
            readOnly: true
          description: Person's computed attributes grouped by type.
          example:
            fullName: Jane Smith
          readOnly: true
        createdFrom:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3'
        createdBy:
          type: string
          description: Identifier of the user who created this person record.
          example: '5'
          readOnly: true
        createdAt:
          type: string
          format: date-time
          description: 'Date and time of creation. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
        modifiedFrom:
          $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3'
        modifiedBy:
          type: string
          description: Identifier of the user who last modified this person record.
          example: '5'
          readOnly: true
        modifiedAt:
          type: string
          format: date-time
          description: 'Date and time of last modification. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
      title: MergePersonV3DocsSchema
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceWithDefaultOptionApiModel:
      type: object
      description: File audio source information.
      properties:
        enabled:
          type: boolean
        useDefault:
          type: boolean
          default: true
          description: Use system default music.
        fileAudioSource:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel'
      title: FileAudioSourceWithDefaultOptionApiModel
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateTreeNodeRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeType'
        name:
          type: string
          description: Name of the tree node.
          example: Getting Started
        targetId:
          type: string
          format: uuid
          description: Identifier of the target node for relative positioning.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        position:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.Position'
        visibility:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility'
      required:
      - name
      - position
      - targetId
      - type
      title: CreateTreeNodeRequest
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessagePersistencePolicy:
      type: string
      default: PERSIST_ALL
      description: 'Message persistence policy. If set to PERSIST_NONE, messages exchanged between customers and

        bot will not be persisted to the database nor visible to agents once they take over the conversation.'
      enum:
      - PERSIST_ALL
      - PERSIST_NONE
      title: MessagePersistencePolicy
    25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.DailyWorkingHoursApiModel:
      type: object
      description: 'List of working hours work days.

        It must contain all days of the week with 3 parameters each: `startTime`, `endTime` and `enabled`.'
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      properties:
        startTime:
          type: integer
          format: int32
          description: Start time of the day in minutes after midnight.
          maximum: 1440
          minimum: 0
        endTime:
          type: integer
          format: int32
          description: End time of the day in minutes before midnight.
          maximum: 1440
          minimum: 0
        enabled:
          type: boolean
          description: Daily working hours enable/disable toggle.
      title: DailyWorkingHoursApiModel
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AwayAudioMessageApiModel:
      type: object
      example:
        id: id
        workingHoursConfigId: '123'
        audioSource:
          enabled: false
          audioSourceType: TTS
          ttsAudioSource:
            text: Random message
            language: en
            voice:
              name: Joanna
              gender: female
            speechRate: 1.1
          fileAudioSource:
            fileDescriptor: file-descriptor-id-example
        collectables:
        - code: '1'
          action: CALLBACK
          value: 62a73f05502423205b2630cc
        collectDuration:
          unit: SECONDS
          value: 15
      properties:
        id:
          type: string
          description: Unique ID of the away audio message.
          readOnly: true
        workingHoursConfigId:
          type: string
          description: Id of the working hours configuration.
          readOnly: true
        audioSource:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel'
        collectables:
          type: array
          items:
            $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CollectableApiModel'
        collectDuration:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel'
      required:
      - audioSource
      title: AwayAudioMessageApiModel
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentDetailResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the attachment.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        name:
          type: string
          description: Name of the attachment.
          example: product-overview.pdf
        downloadPublicUrl:
          type: string
          description: Public URL for downloading the attachment from CDN.
          example: https://cdn.example.com/attachments/product-overview.pdf
        publicContentUrl:
          type: string
          description: Public URL for accessing the attachment in Public Content.
          example: https://public.example.com/attachments/product-overview.pdf
        contentType:
          type: string
          description: MIME type of the attachment.
          example: application/pdf
        sizeInBytes:
          type: integer
          format: int64
          description: Size of the attachment in bytes.
          example: 1048576
        scope:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope'
      required:
      - contentType
      - downloadPublicUrl
      - id
      - name
      - scope
      - sizeInBytes
      title: AttachmentDetailResponse
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformation:
      type: object
      properties:
        phones:
          type: array
          items:
            $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationPhone'
        emails:
          type: array
          items:
            $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationEmail'
        push:
          type: array
          items:
            $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance'
      title: ContactInformation
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPlaceholderTypeApiModel:
      type: string
      description: Placeholder type. Determines the purpose of the placeholder.
      enum:
      - POSITION_IN_QUEUE
      - POSITION_IN_QUEUE
      title: TtsPlaceholderTypeApiModel
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCode:
      type: string
      enum:
      - SUCCESS
      - ERROR
      title: StatusCode
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonTypeV3:
      type: string
      description: Person's type, default type is CUSTOMER.
      enum:
      - CUSTOMER
      - LEAD
      example: CUSTOMER
      title: PersonTypeV3
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserPersonalizationResponse:
      type: object
      properties:
        externalId:
          type: string
          description: Id of a user in external system
        firstName:
          type: string
          description: User first name
        lastName:
          type: string
          description: User last name
        middleName:
          type: string
          description: User middle name
        birthday:
          type: string
          format: date-time
        gender:
          $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiGender'
        customAttributes:
          type: object
          additionalProperties:
            type: object
          description: Set of custom key-value pairs where value can be any of `string`, `number`, `boolean`
        tags:
          type: array
          description: Set of string labels attached to the user
          items:
            type: string
            description: Set of string labels attached to the user
          uniqueItems: true
        contactInformation:
          $ref: '#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformation'
      title: PushUserPersonalizationResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.MoveTreeNodeRequest:
      type: object
      properties:
        position:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.Position'
        targetNodeId:
          type: string
          format: uuid
          description: Identifier of the target node for relative positioning.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      required:
      - position
      - targetNodeId
      title: MoveTreeNodeRequest
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteResultPage:
      type: object
      example:
        notes:
        - id: 9bdb00a1-70f8-4838-ae4b-58fa3e7c93b4
          conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
          agentId: c856e230-a8cd-498b-9996-42bbed35029a
          type: INTERNAL
          content: Note content 1
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
        - id: 10ae8597-029d-4d6b-bf9f-d22c67b4fa42
          conversationId: 4461ea29-c09e-4ba8-a751-df86cf0a0eb9
          agentId: c856e230-a8cd-498b-9996-42bbed35029a
          type: INTERNAL
          content: Note content 2
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
        pagination:
          totalItems: 2
          page: 0
          limit: 10
          orderBy: id:ASC
      properties:
        notes:
          type: array
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteApiResponse'
        pagination:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination'
      title: NoteResultPage
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingStartResponse:
      type: object
      example:
        testId: 123
        sender: '12343534'
      properties:
        testId:
          type: integer
          format: int64
          description: Test Id.
        sender:
          type: string
          description: Sender used in test.
      title: TestingStartResponse
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse:
      type: object
      description: 'Response error codes


        <table>

        <tr><th>Error</th><th>ErrorCode</th><th>HTTP status</th></tr>

        <tr><td>Bad request</td><td>40001</td><td>400</td></tr>

        <tr><td>Duplicate person</td><td>40002</td><td>400</td></tr>

        <tr><td>Person manipulation failed</td><td>40003</td><td>400</td></tr>

        <tr><td>Person already in flow</td><td>40004</td><td>400</td></tr>

        <tr><td>Flow inactive</td><td>40005</td><td>400</td></tr>

        <tr><td>Person is not in the flow</td><td>40006</td><td>400</td></tr>

        <tr><td>Flow not found</td><td>40401</td><td>404</td></tr>

        <tr><td>Person not found</td><td>40402</td><td>404</td></tr>

        <tr><td>Action not found</td><td>40403</td><td>404</td></tr>

        <tr><td>Internal server error</td><td>50001</td><td>500</td></tr>

        </table>'
      example:
        errorCode: 40001
        errorMessage: ''
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
      title: Exception Response
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.InboundTestingRequest:
      type: object
      example:
        message:
          content:
            text: Hello
            type: TEXT
          channel: WHATSAPP
        userDestination: '38595112233'
      properties:
        message:
          $ref: '#/components/schemas/781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicInboundMessage'
        userDestination:
          type: string
          description: Inbound message sender.
      required:
      - message
      - userDestination
      title: InboundTestingRequest
    1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationWebhookReport:
      type: object
      discriminator:
        propertyName: type
        mapping:
          INBOUND_MESSAGE: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.InboundMessageReport'
          OUTBOUND_MESSAGE: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.OutboundMessageReport'
          INBOUND_MESSAGE_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.InboundMessageUpdatedReport'
          INBOUND_MESSAGE_DELETED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.InboundMessageDeletedReport'
          CONVERSATION_CREATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationCreatedReport'
          CONVERSATION_STATUS_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationStatusUpdatedReport'
          CONVERSATION_ASSIGNMENT_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationAssignmentUpdatedReport'
          CONVERSATION_PRIORITY_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationPriorityUpdatedReport'
          CONVERSATION_QUEUE_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationQueueUpdatedReport'
          CONVERSATION_FORM_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationFormUpdatedReport'
          CONVERSATION_FORM_FIELD_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationFormFieldUpdatedReport'
          CONVERSATION_SLA_POLICY_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationSlaPolicyUpdatedReport'
          CONVERSATION_CUSTOMER_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationCustomerUpdatedReport'
          CONVERSATION_SUMMARY_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationSummaryUpdatedReport'
          CONVERSATION_TOPIC_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationTopicUpdatedReport'
          CONVERSATION_TAG_ADDED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationTagAddedReport'
          CONVERSATION_TAG_REMOVED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationTagRemovedReport'
          CONVERSATION_NOTE_ADDED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationNoteAddedReport'
          CONVERSATION_NOTE_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationNoteUpdatedReport'
          CONVERSATION_NOTE_REMOVED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationNoteRemovedReport'
          CONVERSATION_MESSAGE_UPDATED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationMessageUpdatedReport'
          CONVERSATION_DELETED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationDeletedReport'
          CONVERSATION_AGENT_STATUS_CHANGED: '#/components/schemas/1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationAgentStatusChangedReport'
      properties:
        type:
          type: string
          description: Defines the type of conversation event being delivered.
        timestamp:
          type: string
          description: Date and time of the event.
          example: '2025-10-31T13:47:40.032+00:00'
      required:
      - timestamp
      - type
      title: ConversationWebhookReport
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentCreateDto:
      type: object
      properties:
        name:
          type: string
          description: A unique segment name.
          example: VIP Alex Clients
        description:
          type: string
          description: Segment description.
          example: Persons named Alex with tag "VIP Client"
        query:
          type: object
          additionalProperties:
            type: object
            example:
              '#and':
              - firstName: Alex
              - '#contains':
                  tags: VIP Client
          description: "\nAllows to filter persons using simple queries.\n\n##### Supported logical operators\n\n<table>\n    <thead>\n        <tr>\n            <th>Operator</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#and</code></td>\n        <td>All records that match the conditions of all clauses.</td>\n        <td><code>{\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]}</code></td>\n    </tr>\n    <tr>\n        <td><code>#or</code></td>\n        <td>All records that match the conditions of any clause.</td>\n        <td><code>{\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]}</code></td>\n    </tr>\n</table>\n\n##### Supported comparison operators\n\n<table>\n    <thead>\n        <tr>\n            <th>Attributes</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#notExist</code></td>\n        <td>Matches records that do not have given attribute.</td>\n        <td><code>{\"#notExist\":\"firstName\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#exist</code></td>\n        <td>Matches records that have given attribute.</td>\n        <td><code>{\"#exists\":\"firstName\"}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Strings</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified string.</td>\n        <td><code>{\"firstName\":\"John\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified string.</td>\n        <td><code>{\"#ne\":{\"firstName\":\"John\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#startsWith</code></td>\n        <td>Starts with a specified string.</td>\n        <td><code>{\"#startsWith\":{\"firstName\":\"John\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#endsWith</code></td>\n        <td>Ends with a specified string.</td>\n        <td><code>{\"#endsWith\":{\"firstName\":\"John\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#contains</code></td>\n        <td>Contains a specified string.</td>\n        <td><code>{\"#contains\":{\"firstName\":\"oh\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notContain</code></td>\n        <td>Does not contain a specified string.</td>\n        <td><code>{\"#notContain\":{\"firstName\":\"oh\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>At least one of the strings in a list.</td>\n        <td><code>{\"#in\":{\"firstName\":[\"John\",\"Jane\"]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Not any of the strings in a list.</td>\n        <td><code>{\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Dates</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified date.</td>\n        <td><code>{\"birthDate\":\"1987-07-10\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified date.</td>\n        <td><code>{\"#ne\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#eq (relative)</code></td>\n        <td>Will be in specified interval.</td>\n        <td><code>{\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt (relative)</code></td>\n        <td>Will be within a specified interval.</td>\n        <td><code>{\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt (relative)</code></td>\n        <td>Will be in more than a specified interval.</td>\n        <td><code>{\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#eq (relative) -</code></td>\n        <td>Was a specified interval ago.</td>\n        <td><code>{\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt (relative) -</code></td>\n        <td>Was within a specified interval ago.</td>\n        <td><code>{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt (relative) -</code></td>\n        <td>Was more than a specified interval ago.</td>\n        <td><code>{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt</code></td>\n        <td>Is before a specified date.</td>\n        <td><code>{\"#lt\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lte</code></td>\n        <td>Is before or equal to a specified date.</td>\n        <td><code>{\"#lte\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt</code></td>\n        <td>Is after a specified date.</td>\n        <td><code>{\"#gt\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gte</code></td>\n        <td>Is after or equal to a specified date.</td>\n        <td><code>{\"#gte\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>Is equal to one of dates in a given list.</td>\n        <td><code>{\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Is not equal to any of dates in a given list.</td>\n        <td><code>{\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Integers</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified integer.</td>\n        <td><code>{\"data\\u0001counter\":1}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified integer.</td>\n        <td><code>{\"#ne\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt</code></td>\n        <td>Is less than a specified integer.</td>\n        <td><code>{\"#lt\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lte</code></td>\n        <td>Is less than or equal to a specified integer.</td>\n        <td><code>{\"#lte\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt</code></td>\n        <td>Is greater than a specified integer.</td>\n        <td><code>{\"#gt\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gte</code></td>\n        <td>Is greater than or equal to a specified integer.</td>\n        <td><code>{\"#gte\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>Is equal to any of specified integers in a list.</td>\n        <td><code>{\"#in\":{\"data\\u0001counter\":[1,2,3]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Is not equal to any of specified integers in a list.</td>\n        <td><code>{\"#notIn\":{\"data\\u0001counter\":[1,2,3]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Decimals</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified decimal.</td>\n        <td><code>{\"data\\u0001price\":1.1}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Is not equal to a specified decimal.</td>\n        <td><code>{\"#ne\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt</code></td>\n        <td>Is less than a specified decimal.</td>\n        <td><code>{\"#lt\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lte</code></td>\n        <td>Is less than or equal to a specified decimal.</td>\n        <td><code>{\"#lte\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt</code></td>\n        <td>Is greater than a specified decimal.</td>\n        <td><code>{\"#gt\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gte</code></td>\n        <td>Is greater than or equal to a specified decimal.</td>\n        <td><code>{\"#gte\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>Is equal to any of specified decimals in a list.</td>\n        <td><code>{\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Is not equal to any of specified decimals in a list.</td>\n        <td><code>{\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Booleans</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified boolean.</td>\n        <td><code>{\"data\\u0001happy\":true}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified boolean.</td>\n        <td><code>{\"#ne\":{\"data\\u0001happy\":true}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Tags</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#contains</code></td>\n        <td>Contains a specified tag.</td>\n        <td><code>{\"#contains\":{\"tags\":\"SOME_TAG\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notContain</code></td>\n        <td>Does not contain a specified tag.</td>\n        <td><code>{\"#notContain\":{\"tags\":\"SOME_TAG\"}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Gender</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals a specified gender.</td>\n        <td><code>{\"gender\":\"MALE\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Does not equal a specified gender.</td>\n        <td><code>{\"#ne\":{\"gender\":\"FEMALE\"}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Lists</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#all</code></td>\n        <td>All items in the list match.</td>\n        <td><code>{\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}</code>\n        </td>\n    </tr>\n    <tr>\n        <td><code>#any</code></td>\n        <td>Any item in the list match.</td>\n        <td><code>{\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}</code>\n        </td>\n    </tr>\n</table>\n\n"
          example:
            '#and':
            - firstName: Alex
            - '#contains':
                tags: VIP Client
        events:
          type: array
          description: List of events that persons should match.
          items:
            $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.EventClauseDto'
      required:
      - name
      title: SegmentCreateDto
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PayloadOperator:
      type: string
      description: Operator for comparing condition value with payload value.
      enum:
      - EQ
      - LT
      - LTE
      - GT
      - GTE
      - NE
      - SW
      - EW
      - CON
      example: EQ
      title: PayloadOperator
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreStats:
      type: object
      properties:
        position:
          type: integer
          description: Position of the participant on the leaderboard, taking into account tie-breaking.
          title: Position
        rank:
          type: integer
          description: Position of the participant on the leaderboard, not taking into account tie-breaking.
          title: Rank
        tiedWith:
          type: integer
          description: Number of other participants tied with the same score.
          title: Tiedwith
        bestScore:
          type: integer
          description: The highest score achieved by the participant in the campaign.
          title: Bestscore
        attempts:
          type: integer
          description: Total number of attempts made by the participant in the campaign.
          title: Attempts
        attemptsRemaining:
          type: integer
          description: Number of attempts remaining for the participant today.
          title: Attemptsremaining
        nextScoreToBeat:
          type: integer
          description: The next highest score the participant needs to beat to improve their ranking.
          title: Nextscoretobeat
        numberOfParticipants:
          type: integer
          description: Total number of participants in the campaign.
          title: Numberofparticipants
      required:
      - attempts
      - attemptsRemaining
      title: ScoreStats
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormFieldRequest:
      type: object
      description: Fields attached to a form.
      properties:
        fieldId:
          type: string
        isRequired:
          type: boolean
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldConditionRequest'
      required:
      - fieldId
      - isRequired
      title: FormFieldRequest
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.UpsertDispositionApiRequest:
      type: object
      properties:
        fields:
          type: array
          description: List of fields and agent inputs to those fields.
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.UpsertDispositionFieldApiRequest'
          maxItems: 2147483647
          minItems: 1
      required:
      - fields
      title: UpsertDispositionApiRequest
    25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursStatus:
      type: string
      enum:
      - INSIDE_OF_WORKING_HOURS
      - OUTSIDE_OF_WORKING_HOURS
      title: WorkingHoursStatus
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowParticipant:
      type: object
      description: Participant to be added to Flow campaign.
      maxLength: 1000
      properties:
        identifyBy:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.WebhookPersonUniqueField'
        variables:
          type: object
          additionalProperties:
            type: object
          description: Flow variables to assign to the participant when it is added to the flow.
        person:
          $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPersonV2'
      required:
      - identifyBy
      title: FlowParticipant
    25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursResultPageApiResponse:
      type: object
      properties:
        workingHours:
          type: array
          items:
            $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse'
        pagination:
          $ref: '#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.Pagination'
      title: WorkingHoursResultPageApiResponse
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ListItemResource:
      type: object
      additionalProperties: false
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.ListItemType'
          description: Schema type for List items. Must be `Object`.
          minLength: 1
        fields:
          type: array
          description: Fields within the List item object. Must not be empty, must contain no more than `128` items, field names must be unique (case-insensitive).
          items:
            $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ListItemFieldResource'
          maxItems: 128
          minItems: 1
          uniqueItems: true
      required:
      - fields
      - type
      title: ListItemResource
    fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.ListItemType:
      type: string
      description: Schema type for List items.
      enum:
      - Object
      title: ListItemType
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType:
      type: string
      description: Type of the person ID. Can be one of the above.
      enum:
      - ID
      - EXTERNAL_ID
      - PHONE
      - EMAIL
      - LINE
      - FACEBOOK
      - TELEGRAM
      - PUSH
      - LIVE_CHAT
      - VIBER_BOTS
      - INSTAGRAM
      - INSTAGRAM_DM
      - TWITTER
      - APPLE_BUSINESS_CHAT
      - KAKAO_SANGDAM
      - OPEN_CHANNEL
      - ZALO_FOLLOWER
      - TIKTOK_BM
      - WHATSAPP
      - KAKAO_TALK
      title: PersonUniqueFieldType
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleDetailResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the article.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        name:
          type: string
          description: Name of the article.
          example: Getting Started with SMS API
        content:
          type: string
          description: Content of the article in HTML format.
          example: <h1>Introduction</h1><p>This guide covers the basics of the SMS API.</p>
        status:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus'
        tags:
          type: array
          description: Tags assigned to the article.
          items:
            $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagSimpleResponse'
        links:
          type: array
          description: List of Articles Or Attachments linked to the article.
          items:
            $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleLinkDetailResponse'
        lastPublishedAt:
          type: string
          format: date-time
          description: Timestamp of when the article was last published.
          example: '2025-06-15T12:00:00Z'
        createdAt:
          type: string
          format: date-time
          description: Timestamp of when the article was created.
          example: '2025-06-01T08:30:00Z'
        lastUpdatedAt:
          type: string
          format: date-time
          description: Timestamp of when the article was last updated.
          example: '2025-06-15T14:20:00Z'
        likeCount:
          type: integer
          format: int32
          description: Count of positive feedbacks.
          example: 12
        likedByUser:
          type: boolean
          description: Whether the current user has liked this article. Null when no user context is available.
          example: false
        viewCount:
          type: integer
          format: int32
          description: Total view count.
          example: 350
        subscribedByUser:
          type: boolean
          description: Whether the current user is subscribed to this article. Null when no user context is available.
          example: true
        scope:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope'
        source:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource'
        category:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CategoryResponse'
        createdBy:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData'
        folder:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.FolderResponse'
        breadcrumb:
          type: array
          description: Navigation breadcrumb path.
          example:
          - Documentation
          - API Guides
          items:
            type: string
            description: Navigation breadcrumb path.
            example: '["Documentation","API Guides"]'
        lastUpdatedBy:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData'
        lastPublishedBy:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData'
        commentsCount:
          type: integer
          format: int64
          description: Number of comments on the article.
          example: 5
        visibility:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility'
        publicContentUrl:
          type: string
          description: URL to the public content page.
          example: https://kb.infobip.com/articles/3fa85f64
      required:
      - breadcrumb
      - category
      - content
      - createdAt
      - id
      - lastUpdatedAt
      - likeCount
      - links
      - name
      - scope
      - status
      - tags
      - viewCount
      - visibility
      title: ArticleDetailResponse
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.TriggerResultPage:
      type: object
      example:
        items:
        - id: b3695d3c-6415-4bdd-82fc-07f9309933ec
          title: AJ Queue
          expression:
            $neq:
              queue: AJ Queue
          orderIndex: 5
          isEnabled: true
          formId: 75f57446-1d65-478a-87ed-22d17dc3d077
          timesTriggered: 149
        - id: bef60d38-98fa-4c14-b40e-34918b399964
          title: Feedback form triggers
          expression:
            $or:
            - $eq:
                queue: Default queue
            - $and:
              - $eq:
                  customer.country: Croatia
              - $eq:
                  company.name: AAA Infotek
          orderIndex: 1
          isEnabled: true
          formId: 90a91386-6e6d-44da-889f-783705cec020
          timesTriggered: 245
        pagination:
          totalItems: 2
          page: 0
          limit: 10
          orderBy:
            property: id
            direction: ASC
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger'
        pagination:
          $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Pagination'
      title: TriggerResultPage
    d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteRequest:
      type: object
      properties:
        people:
          type: array
          description: List of people.
          items:
            $ref: '#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteEntry'
          readOnly: false
          writeOnly: false
      title: BatchDeleteRequest
    fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionSubcategory:
      type: string
      description: Event definition subcategory.
      enum:
      - sms
      - email
      - push
      - whatsapp
      - viber
      - facebook
      - moments
      - forms
      - conversations
      - mobileapp
      - voice
      - line
      - appleBC
      - rcs
      - mms
      - viberBot
      - inapp
      - answers
      - blocklist
      title: EventDefinitionSubcategory
    ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse:
      type: object
      properties:
        results:
          type: array
          description: List of any unsuccessful result from the batch operation for each processed entry. Example, name used in the request already exists.
          items:
            $ref: '#/components/schemas/ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResult'
          readOnly: false
          writeOnly: false
      title: BatchUpdateResponse
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VoiceClientType:
      type: string
      default: PSTN
      description: Voice client type of the destination number.
      enum:
      - PSTN
      - WEBRTC
      - WHATSAPP
      - VIBER
      - LIVE_CHAT
      title: VoiceClientType
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RuleApiResponse:
      type: object
      properties:
        id:
          type: string
          description: Rule Id.
        priority:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority'
        expression:
          type: object
          additionalProperties:
            type: object
          description: Query for logical validation of new messages. See [Routing](https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing) for more info.
        queueId:
          type: string
          description: Queue Id is a destination queue where the new message will be assigned to.
        queueName:
          type: string
          description: Queue name.
        enabled:
          type: boolean
          default: true
          description: Enabled is a boolean value (TRUE, FALSE), so the rule is engaged or avoided in the routing process. If not provided will be set to default.
        name:
          type: string
          description: Rule name, light description of expression logic.
        createdAt:
          type: string
          format: date-time
          description: Time stamp when rule is created.
        updatedAt:
          type: string
          format: date-time
          description: Time stamp when rule is last updated.
        order:
          type: integer
          format: int32
          description: Position in order of executing this rule for logical validation new message.
        routeOnlyDuringWorkingHours:
          type: boolean
          default: false
          description: When set to true, it indicates that the route should only be processed during designated working hours. [Set up working hours](https://www.infobip.com/docs/api/customer-engagement/conversations-api/create-working-hours)
        isPrivate:
          type: boolean
          default: false
          description: Is route private.
      title: RuleApiResponse
    2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResult:
      type: object
      properties:
        errors:
          type: array
          description: List of errors
          items:
            $ref: '#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError'
          readOnly: false
          writeOnly: false
        isModified:
          type: boolean
        query:
          allOf:
          - $ref: '#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery'
        status:
          type: integer
          format: int32
          description: HTTP status
          readOnly: false
          writeOnly: false
      title: BatchUpdateResult
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse:
      type: object
      properties:
        statusCode:
          $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCode'
        message:
          type: string
      title: StatusCodeResponse
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteContent:
      type: object
      description: Notes content can be any text.
      title: NoteContent
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignSettings:
      type: object
      properties:
        maxDailyAttemptsPerUser:
          type: integer
          default: 30
          description: Maximum number of times a user can participate in the campaign in one day.
          minimum: 1
          title: Maxdailyattemptsperuser
        sttModelProvider:
          $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.STTModelProvider'
          default: AZURE
          description: Speech-to-text model provider used for the campaign. Currently, only 'AZURE' and 'GOOGLE' are supported.
        maxDailyAttemptsPerCampaign:
          type: integer
          default: 1500
          description: Maximum number of times all users can participate in the campaign in one day.
          minimum: 1
          title: Maxdailyattemptspercampaign
      title: CampaignSettings
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Status:
      type: string
      enum:
      - SUCCESS
      - ERROR
      title: Status
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignListResponse:
      type: object
      properties:
        campaigns:
          type: array
          description: List of campaign objects.
          items:
            $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.Campaign'
          title: Campaigns
      required:
      - campaigns
      title: CampaignListResponse
    f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.StatusResponse:
      type: string
      description: Status of the operation.
      enum:
      - SUCCESS
      - FAILURE
      - IN_PROGRESS
      title: StatusResponse
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponseWithEmail:
      type: object
      example:
        id: 97457D13B1FC79AF3C1A1096AE7E77AB
        displayName: Angus Young
        status: ACTIVE
        availability: BUSY
        role: SUPERVISOR
        enabled: true
        createdAt: 2019-05-10T09:53:58.463+0000
        updatedAt: 2019-05-10T09:53:58.463+0000
        email: angus.toung@example.com
      properties:
        id:
          type: string
          description: Agent ID.
          readOnly: true
        displayName:
          type: string
          description: Agent name to be displayed.
          maxLength: 255
          minLength: 0
        status:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup'
        availability:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup'
        role:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRole'
        enabled:
          type: boolean
          default: true
          description: Agent enabled/disabled toggle.
        createdAt:
          type: string
          format: date-time
          description: Time stamp when agent is created.
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          description: Time stamp when agent is last updated.
          readOnly: true
        email:
          type: string
          description: Agent email address.
      required:
      - displayName
      title: AgentResponseWithEmail
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup:
      type: string
      description: Agent availability.
      enum:
      - ACTIVE
      - BUSY
      - INVISIBLE
      - AWAY
      title: AgentStatusGroup
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageInfo:
      type: object
      description: Contains information about the page.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UpdateTreeNodeRequest:
      type: object
      properties:
        name:
          type: string
          description: New name of the tree node.
          example: Getting Started
      required:
      - name
      title: UpdateTreeNodeRequest
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CollectableApiModel:
      type: object
      description: Information for a collectable.
      properties:
        code:
          type: string
          description: Code attached to the collectable.
          maxLength: 36
          minLength: 1
        action:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Action'
        value:
          type: string
          description: Collectable value.
          maxLength: 64
          minLength: 1
      required:
      - action
      - code
      - value
      title: CollectableApiModel
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPersonContactsV2:
      type: object
      description: List of phones, emails and other information how a person can be contacted.
      properties:
        phone:
          type: array
          description: A list of person's phone numbers. Max 100 numbers per person.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPhoneContact'
        email:
          type: array
          description: A list of person's email addresses. Max 100 emails per person.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamEmailContact'
        push:
          type: array
          description: List of person's push registrations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPushContactV2'
          readOnly: true
        facebook:
          type: array
          description: A list of person's Messenger destinations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact'
          readOnly: true
        line:
          type: array
          description: A list of person's Line destinations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact'
          readOnly: true
        viberBots:
          type: array
          description: A list of person's Viber Bots destinations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact'
          readOnly: true
        liveChat:
          type: array
          description: A list of person's Live Chat destinations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact'
          readOnly: true
        instagram:
          type: array
          description: A list of person's Instagram destinations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact'
          readOnly: true
        telegram:
          type: array
          description: A list of person's Telegram destinations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact'
          readOnly: true
        appleBusinessChat:
          type: array
          description: A list of person's Apple Business Chat destinations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact'
          readOnly: true
        webpush:
          type: array
          description: A list of person's web push destinations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonPushContact'
          readOnly: true
        instagramDm:
          type: array
          description: A list of person's Instagram DM destinations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact'
          readOnly: true
        kakaoSangdam:
          type: array
          description: A list of person's Kakao Sangdam destinations.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact'
          readOnly: true
      title: IamPersonContactsV2
    731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2:
      type: object
      properties:
        createdAt:
          type: string
          description: 'Date and time of creation. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
          writeOnly: false
        id:
          type: integer
          format: int64
          description: Unique id of the entity.
          readOnly: true
          writeOnly: false
        modifiedAt:
          type: string
          description: 'Date and time of last modification. Has the following format: yyyy-MM-dd''T''HH:mm:ss.'
          readOnly: true
          writeOnly: false
        name:
          type: string
          description: Tag name, 256 characters max.
          readOnly: false
          writeOnly: false
      title: IamTagV2
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferStrategyApiModel:
      type: object
      example:
        id: 642bf5f4ff5dd177aeb00889
        musicOnHold:
          enabled: true
          useDefault: false
          fileAudioSource:
            fileDescriptor: f829e911-8439-4321-aa25-23b321e1a9cb
        announcementMessage:
          enabled: true
          audioSourceType: TTS
          ttsAudioSource:
            text: You're are being transferred...
            language: en
            voice:
              name: Joanna
              gender: FEMALE
            speechRate: 1.0
          fileAudioSource: null
          repeatInterval:
            unit: SECONDS
            value: 5
        createdAt: '2023-04-04T10:03:32.729Z'
        updatedAt: '2023-04-06T11:22:18.149Z'
      properties:
        id:
          type: string
          description: Unique id of the transfer strategy.
          readOnly: true
        musicOnHold:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceWithDefaultOptionApiModel'
        announcementMessage:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileOrTtsAudioSourceWithRepeatIntervalApiModel'
        createdAt:
          type: string
          example: 2023-04-04T10:03:32.729+0000
          readOnly: true
        updatedAt:
          type: string
          example: 2023-04-06T11:22:18.149+0000
          readOnly: true
      title: TransferStrategyApiModel
    f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.RequestDetailsResponse:
      type: object
      description: Details about user request status.
      properties:
        account:
          type: string
          description: Account identifier.
        status:
          $ref: '#/components/schemas/f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.StatusResponse'
        errorMessage:
          type: string
          description: Error message.
        errorCode:
          type: integer
          format: int32
          description: Error code.
      required:
      - account
      - status
      title: RequestDetailsResponse
    8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse:
      type: object
      properties:
        results:
          type: array
          description: List of result from the batch operation for each processed entry. Example, the first company was created, the second company wasn't created because name already exists.
          items:
            $ref: '#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResult'
          readOnly: false
          writeOnly: false
      title: BatchCreateResponse
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.DispositionFieldBasic:
      type: object
      description: A list of fields with values.
      properties:
        fieldId:
          type: string
          description: Field id.
        dispositionId:
          type: string
          description: Disposition id.
        dispositionValue:
          type: string
          description: Value of the field.
      title: DispositionFieldBasic
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversationMember:
      type: object
      description: A conversation that is linked to another conversation.
      properties:
        conversationId:
          type: string
          description: Conversation ID.
        createdAt:
          type: string
          format: date-time
          description: Time when the conversation was created.
        updatedAt:
          type: string
          format: date-time
          description: Time when the conversation was last updated.
        agentId:
          type: string
          description: ID of the assigned agent.
        topic:
          type: string
          description: Conversation topic.
        channel:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationChannel'
        status:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationStatus'
        customerDisplayName:
          type: string
          description: Display name of the customer.
      title: LinkedConversationMember
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormDataPayloadMap:
      type: object
      additionalProperties:
        type: object
        description: Field name and its value
      description: Field name and its value
      title: FormDataPayloadMap
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.BackgroundFileMetadataApiModel:
      type: object
      description: Background file metadata in case of virtual background.
      properties:
        fileId:
          type: string
          description: Id of specified background image file.
        fileName:
          type: string
          description: Name of specified background image file.
        fileSize:
          type: integer
          format: int64
          description: Size in bytes of specified background image file.
        fileUrl:
          type: string
          description: File url of specified background image file.
      required:
      - fileId
      - fileName
      - fileUrl
      title: BackgroundFileMetadataApiModel
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchRequest:
      type: object
      properties:
        identities:
          type: array
          description: List of identities.
          items:
            $ref: '#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ByUniqueRequestParameters'
      required:
      - identities
      title: MatchRequest
    67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType:
      type: string
      enum:
      - ID
      - EXTERNAL_ID
      - PHONE
      - EMAIL
      - LINE
      - FACEBOOK
      - TELEGRAM
      - PUSH
      - WEB_PUSH
      - LIVE_CHAT
      - VIBER_BOTS
      - INSTAGRAM
      - INSTAGRAM_DM
      - TWITTER
      - APPLE_BUSINESS_CHAT
      - KAKAO_SANGDAM
      - OPEN_CHANNEL
      - ZALO_FOLLOWER
      - TIKTOK_BM
      - WHATSAPP
      title: PersonUniqueFieldType
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Bot:
      type: object
      example:
        displayName: My Whatsapp Bot
        webhookUrl: www.webhookurl.com/link1
        destination: '447492263897'
        channel: WHATSAPP
        messagePersistencePolicy: PERSIST_ALL
        enabled: true
        sessionTimeoutInSec: 120
      properties:
        displayName:
          type: string
          description: Bot name to be displayed.
          maxLength: 255
          minLength: 0
        webhookUrl:
          type: string
          description: Webhook url the message will be forwarded to.
          maxLength: 2000
          minLength: 0
        destination:
          type: string
          description: Bot destination phone number, FB messenger ID or live chat widget ID.
          maxLength: 255
          minLength: 0
        enabled:
          type: boolean
          default: true
          description: Bot enable/disable toggle.
        messagePersistencePolicy:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessagePersistencePolicy'
        channel:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessageChannel'
        sessionTimeoutInSec:
          type: integer
          format: int64
          default: 86400
          description: Time elapsed from last client message, after which conversation will be closed. If not set, conversation will be closed after 24 hours.
          maximum: 86400
          minimum: 60
        webhookHeaders:
          type: object
          additionalProperties:
            type: string
            deprecated: true
          deprecated: true
        webhookEventUrl:
          type: string
          maxLength: 2000
          minLength: 0
        webhookEventHeaders:
          type: object
          additionalProperties:
            type: string
        id:
          type: string
          readOnly: true
      required:
      - channel
      - destination
      - displayName
      - id
      title: Bot
    3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError:
      type: object
      properties:
        message:
          type: string
          description: Error message
          readOnly: false
          writeOnly: false
      title: BatchOperationError
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionOccurred:
      type: string
      description: Specifies whether an event is occurring for the first or last time within a given period. Additionally, we can use an operator to specify if any event has occurred or never occurred within the specified timeframe.
      enum:
      - ALL
      - FIRST
      - LAST
      - NOT
      example: ALL
      title: TimelineConditionOccurred
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AccountConfigurationRequest:
      type: object
      example:
        webhookUrl: https://www.url.com/assets/receive/url
      properties:
        webhookUrl:
          type: string
          description: Webhook url all inbound messages will be forwarded to.
          maxLength: 255
          minLength: 0
      title: AccountConfigurationRequest
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormListDto:
      type: object
      properties:
        forms:
          type: array
          description: Forms list
          items:
            $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormDto'
        offset:
          type: integer
          format: int32
          description: Offset from beginning of list of available forms
        limit:
          type: integer
          format: int32
          description: Number of returned forms
        total:
          type: integer
          format: int64
          description: Total number of available forms
      required:
      - forms
      title: ApiFormListDto
    0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiGender:
      type: string
      description: User gender
      enum:
      - MALE
      - FEMALE
      title: PushApiGender
    61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPersonContactsV2:
      type: object
      properties:
        appleBusinessChat:
          type: array
          description: A list of person's Apple Business Chat destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        email:
          type: array
          description: A list of person's email addresses. Max 100 emails per person.
          items:
            $ref: '#/components/schemas/61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamEmailContactV2'
          readOnly: false
          writeOnly: false
        facebook:
          type: array
          description: A list of person's Messenger destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        instagram:
          type: array
          description: A list of person's Instagram destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        instagramDm:
          type: array
          description: A list of person's Instagram DM destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        kakaoSangdam:
          type: array
          description: A list of person's Kakao Sangdam destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        line:
          type: array
          description: A list of person's Line destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        liveChat:
          type: array
          description: A list of person's Live Chat destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        openChannel:
          type: array
          description: A list of person's Open Channel destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        phone:
          type: array
          description: A list of person's phone numbers. Max 100 numbers per person.
          items:
            $ref: '#/components/schemas/61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPhoneContactV2'
          readOnly: false
          writeOnly: false
        push:
          type: array
          description: List of person's push registrations.
          items:
            $ref: '#/components/schemas/61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPushContactV2'
          readOnly: true
          writeOnly: false
        telegram:
          type: array
          description: A list of person's Telegram destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        tiktokBm:
          type: array
          description: A list of person's TikTok Business Messaging destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        twitter:
          type: array
          description: A list of person's Twitter destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        viberBots:
          type: array
          description: A list of person's Viber Bots destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        webpush:
          type: array
          description: A list of person's web push registrations
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonPushContact'
          readOnly: true
          writeOnly: false
        whatsapp:
          type: array
          description: A list of person's WhatsApp destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
        zaloFollower:
          type: array
          description: A list of person's Zalo Follower destinations.
          items:
            $ref: '#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact'
          readOnly: true
          writeOnly: false
      title: IamPersonContactsV2
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessageChannel:
      type: string
      enum:
      - SMS
      - VIBER
      - FACEBOOK_MESSENGER
      - WHATSAPP
      - RCS
      - UNKNOWN
      - EMAIL
      - LIVE_CHAT
      - UNUSED
      - VOICE
      - VIDEO
      - APPLE_BUSINESS_CHAT
      - LINE
      - GOOGLE_BUSINESS_MESSAGES
      - TELEGRAM
      - CALLS
      - INTERNAL
      - VIBER_BOT
      - FACEBOOK_POST
      - INSTAGRAM_POST
      - TWITTER_POST
      - INSTAGRAM_MESSAGING
      - GOOGLE_PLAY
      - KAKAO_SANGDAM
      - TWITTER_DM
      - WHATSAPP_CALLS
      - VIBER_CALLS
      - OPEN_CHANNEL
      - TIKTOK
      - ZALO
      title: MessageChannel
    41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3:
      type: string
      description: Source system that last modified this person record.
      enum:
      - API
      - PORTAL
      - WEB_SDK
      - INTEGRATION
      - PUSH
      - FACEBOOK
      - LINE
      - TELEGRAM
      - SALESFORCE
      - DYNAMICS
      - ZAPIER
      - FORMS
      - AMS
      - COMPUTED
      - ANSWERS
      - CONVERSATIONS
      - IMPORT
      - INSTAGRAM_DM
      - FLOW
      - LIVE_CHAT
      - VKONTAKTE
      - ZALO_FOLLOWER
      - TIKTOK_BM
      - WHATSAPP
      - KAKAO_TALK
      - UNKNOWN
      example: API
      readOnly: true
      title: OriginV3
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormDto:
      type: object
      properties:
        id:
          type: string
          description: Form identifier
        name:
          type: string
          description: Form name
        elements:
          type: array
          description: List of form fields
          items:
            $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormElementDto'
        createdAt:
          type: string
          format: date-time
          description: Time when form was created
        updatedAt:
          type: string
          format: date-time
          description: Time when form was update last time
        actionAfterSubmission:
          $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ActionAfterSubmission'
        resubmitEnabled:
          type: boolean
          description: Can resubmit multiple times
        formType:
          $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormType'
        formStatus:
          $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormStatus'
      required:
      - elements
      - formStatus
      - formType
      - id
      - name
      - resubmitEnabled
      title: ApiFormDto
    a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamTypeV2:
      type: string
      enum:
      - CUSTOMER
      - LEAD
      title: IamTypeV2
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Pagination:
      type: object
      properties:
        totalItems:
          type: integer
          format: int64
          readOnly: true
        page:
          type: integer
          format: int32
          readOnly: true
        limit:
          type: integer
          format: int32
          readOnly: true
        orderBy:
          type: string
          readOnly: true
      title: Pagination
    9a0795f64a40f2cbc302ee52c186009a1de422921e2055e9284671cdc2107f5b.IamAdditionalFieldDataType:
      type: string
      enum:
      - STRING
      - DECIMAL
      - INTEGER
      - BOOLEAN
      - DATE
      - DATE_TIME
      - LIST_OF_OBJECTS
      title: IamAdditionalFieldDataType
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.DialogInformation:
      type: object
      description: Dialog in which the event occurred.
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
      required:
      - id
      - name
      title: DialogInformation
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Direction:
      type: string
      enum:
      - ASC
      - DESC
      title: Direction
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ActionAfterSubmission:
      type: object
      description: Action after the submission
      properties:
        type:
          $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ActionAfterSubmissionType'
        value:
          type: string
      required:
      - type
      - value
      title: ActionAfterSubmission
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.UpsertDispositionFieldApiRequest:
      type: object
      description: List of fields and agent inputs to those fields.
      properties:
        fieldId:
          type: string
        value:
          type: string
          maxLength: 5000
          minLength: 0
      required:
      - fieldId
      - value
      title: UpsertDispositionFieldApiRequest
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationResultPage:
      type: object
      example:
        conversations:
        - id: 9542b329-01f4-4593-b7b0-606949389129
          topic: First conversation topic
          summary: First conversation summary
          status: OPEN
          priority: NORMAL
          queueId: null
          agentId: null
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
        - id: be2de5f9-d049-446b-8c62-098be8b8f624
          topic: Second conversation topic
          summary: Second conversation summary
          status: SOLVED
          priority: HIGH
          queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
          agentId: c856e230-a8cd-498b-9996-42bbed35029a
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
        - id: 7e40af76-3020-4bf6-942f-27910d33899b
          topic: Third conversation topic
          summary: Third conversation topic
          status: CLOSED
          priority: LOW
          queueId: 6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a
          agentId: c856e230-a8cd-498b-9996-42bbed35029a
          createdAt: '2024-01-01T00:00:00.000+00:00'
          updatedAt: '2024-01-01T00:00:00.000+00:00'
          closedAt: '2024-01-03T00:00:00.000+00:00'
        pagination:
          totalItems: 3
          page: 0
          limit: 10
          orderBy: id:ASC
      properties:
        conversations:
          type: array
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel'
        pagination:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination'
      title: ConversationResultPage
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiRequest:
      type: object
      example:
        name: Test WebForm
        channel: EMAIL
        destination: destination@email.test
        url: /ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post
        enabled: true
      properties:
        name:
          type: string
          description: Web Form name.
        channel:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationChannel'
        destination:
          type: string
          description: Web Form destination.
        url:
          type: string
          description: Web Form URL.
        enabled:
          type: boolean
          description: Web Form enable/disable toggle.
        tagIds:
          type: array
          description: List of tag Ids used on the Web Form.
          items:
            type: string
            description: List of tag Ids used on the Web Form.
      required:
      - channel
      - destination
      - enabled
      - name
      title: WebFormApiRequest
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.MediaTypeApiModel:
      type: string
      description: Specifies whether the recording should be done on audio or both audio and video.
      enum:
      - AUDIO
      - AUDIO_AND_VIDEO
      title: MediaTypeApiModel
    59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusRequest:
      type: object
      example:
        status: ACTIVE
      properties:
        status:
          $ref: '#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup'
      required:
      - status
      title: AgentStatusRequest
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field:
      type: object
      properties:
        id:
          type: string
          description: Field id.
        title:
          type: string
          description: Field title.
        type:
          $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldType'
        regex:
          type: string
          description: Regular expression. Valid only for REGEX field type.
        isEnabled:
          type: boolean
          description: Is field enabled
        isDefault:
          type: boolean
        options:
          type: array
          description: List of available options.
          items:
            type: string
            description: List of available options.
        createdAt:
          type: string
        updatedAt:
          type: string
        operators:
          type: array
          description: List of available operators based on field type.
          items:
            $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldOperator'
      title: Field
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ComponentType:
      type: string
      enum:
      - TEXT
      - TEXTAREA
      - NUMBER
      - DROPDOWN
      - CHECKBOX
      - CHECKBOX_GROUP
      - RADIOBUTTON
      - DATE
      - DATETIME
      - EMAIL
      - MSISDN
      - SUBMIT_BUTTON
      - TITLE
      - DESCRIPTION
      - APPLE_SPLASH
      - APPLE_BOOLEAN
      - WHATSAPP_SCREEN
      - WHATSAPP_HEADING
      - WHATSAPP_SUBHEADING
      - WHATSAPP_BODY
      title: ComponentType
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateApiResponse:
      type: object
      description: List of templates.
      example:
        id: c4391685-b21a-4c21-a470-5453e9382752
        name: Template name
        language: English
        languageCode: en
        channel: SMS
        external: false
        content: Simple text content
        createdAt: '2024-01-01T00:00:00.000+00:00'
        updatedAt: '2024-01-01T00:00:00.000+00:00'
        tags:
        - name: Template tag
          createdAt: '2024-12-10T00:00:00.000+00:00'
          updatedAt: '2024-12-10T00:00:00.000+00:00'
        attachments: []
      properties:
        id:
          type: string
          description: Template id.
        name:
          type: string
          description: Template name.
        language:
          type: string
          description: Language used when constructing template content.
        languageCode:
          type: string
          description: Language code used when constructing template content.
        channel:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageChannel'
        external:
          type: boolean
          description: 'Boolean flag that indicates whether the template is external, WhatsApp pre-registered, or internal user-defined.

            If the flag is true, then the template is WhatsApp pre-registered, otherwise, it is user-defined.'
        contentType:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType'
        content:
          type: object
          description: Template content.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when template was created.
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when template was updated.
        tags:
          type: array
          description: List of template tags.
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateTagApiResponse'
        attachments:
          type: array
          description: List of template attachments.
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateFileApiResponse'
        sender:
          type: string
      title: TemplateApiResponse
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400:
      type: object
      properties:
        errorCode:
          type: string
          description: Error code uniquely identifying the error case.
          examples:
          - E400
          title: Errorcode
        description:
          type: string
          description: Detailed description of an error.
          examples:
          - The request could not be processed due to invalid parameters or data.
          title: Description
        action:
          type: string
          description: Action that should be taken to recover from the error.
          examples:
          - Please check your request parameters and ensure all required fields are provided with valid values.
          title: Action
        violations:
          type: array
          description: List of violations that caused the error.
          examples:
          - - property: property.path
              violation: Violation message
          items:
            $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIErrorViolations'
          title: Violations
        resources:
          type: array
          default: []
          description: List of available resources to recover from the error.
          examples:
          - []
          items:
            $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIErrorResources'
          title: Resources
      required:
      - action
      - description
      - errorCode
      - violations
      title: APIError400
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageContent:
      type: object
      description: Message content depending on content type.
      title: MessageContent
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel:
      type: object
      title: MessageChannel
    9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldRequest:
      type: object
      properties:
        title:
          type: string
          description: Field title.
          maxLength: 100
          minLength: 0
        type:
          $ref: '#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldType'
        isEnabled:
          type: boolean
          description: Is field enabled. Mandatory when updating.
        options:
          type: array
          description: Available field options. Applicable only for DROPDOWN type.
          items:
            type: string
            description: Available field options. Applicable only for DROPDOWN type.
        regex:
          type: string
          description: Regular expression. Applicable only for REGEX type.
      required:
      - isEnabled
      - title
      - type
      title: FieldRequest
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.RecordingMetadataApiModel:
      type: object
      example:
        elements:
        - id: 1
          recordingId: 11f1b111-1111-1111-a111-1111e11f111e
          conversationId: 11f1b111-1111-1111-a111-1111e11f111a
          conferenceId: 11f1b111-1111-1111-a111-1111e11f111b
          callId: 11f1b111-1111-1111-a111-1111e11f111c
          direction: INBOUND
          recordingStatus: SUCCESSFUL
          composed: false
          filename: 11f1b111-1111-1111-a111-1111e11f111a_IDENTITY_20230612155341-11f1b111-1111-1111-a111-1111e11f111e.wav
          duration: 28
          participantId: 11f1b111-1111-1111-a111-1111e11f111d
          participantIdentity: customer1
          participantName: Customer 1
          participantType: CUSTOMER
          mediaType: AUDIO
          startedAt: 1686585221999
          deletedAt: null
          deletedBy: null
          sftpPath: null
          transferredFrom: null
          transferredTo: null
          transferredFromQueue: null
          transferredToQueue: null
        - id: 2
          recordingId: 52341263-0a22-1111-a1a1-1111bade8581
          conversationId: 52341263-0a22-1111-a1a1-1111bade8582
          conferenceId: 52341263-0a22-1111-a1a1-1111bade8583
          callId: 52341263-0a22-1111-a1a1-1111bade8584
          direction: INBOUND
          recordingStatus: SUCCESSFUL
          composed: false
          filename: 52341263-0a22-1111-a1a1-1111bade8582_IDENTITY_20230612155341-52341263-0a22-1111-a1a1-1111bade8581.wav
          duration: 28
          participantId: 52341263-0a22-1111-a1a1-1111bade8584
          participantIdentity: agent1
          participantName: Agent 1
          participantType: AGENT
          mediaType: AUDIO
          startedAt: 1686585221999
          deletedAt: null
          deletedBy: null
          sftpPath: null
          transferredFrom: null
          transferredTo: null
          transferredFromQueue: null
          transferredToQueue: null
        total: 2
        totalPages: 1
      properties:
        recordingId:
          type: string
          description: Unique id of the recorded file.
        conversationId:
          type: string
          description: Conversation id of the recorded file.
        conferenceId:
          type: string
          description: Conference id of the recorded file.
        callId:
          type: string
          description: Call id of the recorded file.
        direction:
          type: string
          description: Call direction of the recorded file.
        recordingStatus:
          type: string
          description: Status of the recorded file.
        composed:
          type: boolean
          description: Flag indicating whether the recorded file is composed.
        filename:
          type: string
          description: Filename of the recorded file.
        duration:
          type: integer
          format: int64
          description: Duration of the recorded file in seconds.
        participantId:
          type: string
          description: Unique id of the participant associated with the recorded file.
        participantIdentity:
          type: string
          description: Unique identity of the participant associated with the recorded file.
        participantName:
          type: string
          description: Participant name associated with the recorded file.
        participantType:
          type: string
          description: Participant type associated with the recorded file. Values can be either customer or agent.
        mediaType:
          type: string
          description: Specifies recorded file type. Values can be either audio or audio and video.
        startedAt:
          type: integer
          format: int64
          description: Unix timestamp for when the recording started.
          example: 1686585221999
        deletedAt:
          type: integer
          format: int64
          description: Unix timestamp for when the recorded file was deleted.
          example: 1686585221999
        deletedBy:
          type: string
          description: Identity of the user who deleted the recorded file.
        sftpPath:
          type: string
          description: Location of the recorded file on the SFTP server.
        transferredFrom:
          type: string
          description: Identity of the user who has transferred the call.
        transferredTo:
          type: string
          description: Identity of the user to whom the call has been transferred.
        transferredFromQueue:
          type: string
          description: Queue id from which the call has been transferred.
        transferredToQueue:
          type: string
          description: Queue id to which the call has been transferred.
      title: RecordingMetadataApiModel
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversations:
      type: object
      description: Linked conversations response.
      properties:
        linkedConversations:
          type: array
          description: List of linked conversation pairs.
          items:
            $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversation'
      title: LinkedConversations
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPushContactV2:
      type: object
      description: List of person's push registrations.
      properties:
        applicationId:
          type: string
          description: Application Id on which the user is subscribed.
          readOnly: true
        registrationId:
          type: string
          description: Push registration ID.
          readOnly: true
        additionalData:
          type: object
          additionalProperties:
            type: object
            readOnly: true
          description: Unique user ID for a person.
          readOnly: true
        systemData:
          type: object
          additionalProperties:
            type: object
            readOnly: true
          description: System data collected from the user's profile.
          readOnly: true
        isPrimary:
          type: boolean
          description: Set to true if this device is a primary device of a user among other devices.
          readOnly: true
      readOnly: true
      title: IamPushContactV2
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageTagListItemResponse:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagListItemResponse'
        paging:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo'
      required:
      - paging
      - results
      title: PageTagListItemResponse
    b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource:
      type: object
      additionalProperties: false
      properties:
        title:
          type: string
          description: 'Event definition title. Must not be empty. Maximum length: `100` characters.<br>**Note**: The title cannot be changed for a template definition. If the client tries to update the value, it will be overwritten with the standard title from the template.'
          maxLength: 100
          minLength: 1
        description:
          type:
          - string
          - 'null'
          description: 'Event definition description. Maximum length: `2000` characters.<br>**Note**: The description cannot be changed for a template definition. If the client tries to update the value, it will be overwritten with the standard description from the template.'
          maxLength: 2000
        fields:
          type:
          - array
          - 'null'
          description: Event definition fields. The total number of fields cannot exceed `120`. Field names must be unique (case-insensitive). The number of fields of type `List` cannot exceed `1`. Only new fields can be added; existing fields **cannot** be removed or changed.
          items:
            $ref: '#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventFieldResource'
          maxItems: 120
          uniqueItems: true
      required:
      - title
      title: EventDefinitionUpdateResource
    082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormElementDto:
      type: object
      description: List of form fields
      properties:
        component:
          $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ComponentType'
        fieldId:
          type: string
        personField:
          type: string
        label:
          type: string
        isRequired:
          type: boolean
        isHidden:
          type: boolean
        additionalConfiguration:
          type: object
          additionalProperties:
            type: string
        textContent:
          type: string
        options:
          type: array
          items:
            $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormElementOptionDto'
        validationRules:
          $ref: '#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ValidationRules'
        placeholder:
          type: string
        checkboxText:
          type: string
        validationMessages:
          type: object
          additionalProperties:
            type: string
      required:
      - component
      title: FormElementDto
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleListItemResponse:
      type: object
      description: The list of the results for this page.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the article.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        name:
          type: string
          description: Name of the article.
          example: Getting Started with SMS API
        status:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus'
        tags:
          type: array
          description: Tag names assigned to the article.
          example:
          - sms
          - api
          items:
            type: string
            description: Tag names assigned to the article.
            example: '["sms","api"]'
        lastUpdatedAt:
          type: string
          format: date-time
          description: Timestamp of when the article was last updated.
          example: '2025-06-15T14:20:00Z'
        scope:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope'
        source:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource'
        visibility:
          $ref: '#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility'
        breadcrumb:
          type: array
          description: Navigation breadcrumb path from root to article.
          example:
          - Documentation
          - API Guides
          items:
            type: string
            description: Navigation breadcrumb path from root to article.
            example: '["Documentation","API Guides"]'
      required:
      - id
      - lastUpdatedAt
      - name
      - scope
      - status
      - tags
      - visibility
      title: ArticleListItemResponse
    ApiRequestError:
      type: object
      properties:
        serviceException:
          $ref: '#/components/schemas/ApiRequestErrorDetails'
      title: ApiRequestError
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToQueueRequest:
      type: object
      example:
        queueId: FAC58F4117D439CF6F0A1A1A3AEA6123
      properties:
        queueId:
          type: string
          description: Id of the queue to which a call should be transferred.
          example: FAC58F4117D439CF6F0A1A1A3AEA6123
      title: TransferToQueueRequest
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo:
      type: object
      description: Contains information about the page.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.UpdateQueueApiRequest:
      type: object
      example:
        name: Spanish Support
        isAutoAssignmentEnabled: true
        autoAssignmentAlgorithm: LOAD_BALANCING
        isAutoAssignmentOutsideOfWorkingHoursEnabled: false
        stickyAgentTimeoutDays: 7
        isStickyAutoAssignmentEnabled: true
        workingHoursId: null
        isRestricted: false
        externalId: null
      properties:
        name:
          type: string
          description: Queue name.
          maxLength: 255
          minLength: 0
        isAutoAssignmentEnabled:
          type: boolean
          default: true
          description: Queue Auto-assignment toggle.
        autoAssignmentAlgorithm:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AutoAssignmentAlgorithm'
        isAutoAssignmentOutsideOfWorkingHoursEnabled:
          type: boolean
          default: false
          description: Queue Auto-assignment Outside of Working hours toggle
        stickyAgentTimeoutDays:
          type: integer
          format: int64
          description: Number of days since last interaction with the customer.
        isStickyAutoAssignmentEnabled:
          type: boolean
          description: Auto-assignment according to last interaction with the customer.
        workingHoursId:
          type: string
          description: Working hours Id queue belongs to
        isRestricted:
          type: boolean
          default: false
          description: Is queue restricted.
        externalId:
          type: string
          description: External identifier for the queue.
      title: UpdateQueueApiRequest
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateRuleApiRequest:
      type: object
      example:
      - priority: URGENT
        queueId: 448bf76d-0047-49a3-93a4-ea8722d6aeaa
        enabled: true
        name: First Rule
        routeOnlyDuringWorkingHours: true
        expression:
          $or:
          - $eq:
              message.channel: WHATSAPP
          - $eq:
              message.channel: LIVE_CHAT
      - priority: HIGH
        queueId: 448bf76d-0047-49a3-93a4-ea8722d7aeab
        enabled: true
        name: Second Rule
        routeOnlyDuringWorkingHours: false
        expression:
          $and:
          - $eq:
              message.channel: TELEGRAM
          - $eq:
              customer.country: Croatia
      - priority: NORMAL
        queueId: 39b52b7f-db13-4c47-9b6e-de2ba91df62g
        queueName: Third Queue
        enabled: true
        name: Third Rule
        routeOnlyDuringWorkingHours: false
        expression:
          $eq:
            message.channel: VIBER
      properties:
        priority:
          $ref: '#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority'
        expression:
          type: object
          additionalProperties:
            type: object
          description: Query for logical validation of new messages. See [Routing](https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing) for more info.
        queueId:
          type: string
          description: Queue Id is a destination queue where the new message will be assigned to.
          maxLength: 255
          minLength: 0
        enabled:
          type: boolean
          default: true
          description: Enabled is a boolean value (TRUE, FALSE), so the rule is engaged or avoided in the routing process. If not provided will be set to default.
        name:
          type: string
          description: Rule name, light description of expression logic.
          maxLength: 255
          minLength: 0
        routeOnlyDuringWorkingHours:
          type: boolean
          default: false
          description: When set to true, it indicates that the route should only be processed during designated working hours. [Set up working hours](https://www.infobip.com/docs/api/customer-engagement/conversations-api/create-working-hours)
      required:
      - expression
      - queueId
      title: CreateRuleApiRequest
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.FolderResponse:
      type: object
      description: Parent folder of the article.
      properties:
        name:
          type: string
          description: Name of the folder.
          example: Getting Started
        id:
          type: string
          format: uuid
          description: Unique identifier of the folder.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      required:
      - id
      - name
      title: FolderResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CategoryResponse:
      type: object
      description: Parent category of the article.
      properties:
        name:
          type: string
          description: Name of the category.
          example: API Guides
        id:
          type: string
          format: uuid
          description: Unique identifier of the category.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      required:
      - id
      - name
      title: CategoryResponse
    09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagCreateRequest:
      type: object
      properties:
        name:
          type: string
          description: Name for the tag.
          example: sms-api
          pattern: ^[^,]+$
      required:
      - name
      title: TagCreateRequest
    781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingStartRequest:
      type: object
      example:
        botId: 123
        sender: '12343534'
        webhookUrl: http://example.com
      properties:
        botId:
          type: integer
          format: int64
          description: Chatbot Id.
        sender:
          type: string
          description: Chatbot sender, if omitted will default to WEB_SIMULATION.
        webhookUrl:
          type: string
          description: Url to send bot test events.
      required:
      - botId
      - webhookUrl
      title: TestingStartRequest
    f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest:
      type: object
      properties:
        people:
          type: array
          description: List of people.
          items:
            $ref: '#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.PersonsToCompanyEntry'
          readOnly: false
          writeOnly: false
      title: BatchPersonsToCompanyRequest
    d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentUpdateDto:
      type: object
      properties:
        name:
          type: string
          description: A unique segment name.
          example: VIP Alex Clients
        description:
          type: string
          description: Segment description.
          example: Persons named Alex with tag "VIP Client"
        query:
          type: object
          additionalProperties:
            type: object
            example:
              '#and':
              - firstName: Alex
              - '#contains':
                  tags: VIP Client
          description: "\nAllows to filter persons using simple queries.\n\n##### Supported logical operators\n\n<table>\n    <thead>\n        <tr>\n            <th>Operator</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#and</code></td>\n        <td>All records that match the conditions of all clauses.</td>\n        <td><code>{\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]}</code></td>\n    </tr>\n    <tr>\n        <td><code>#or</code></td>\n        <td>All records that match the conditions of any clause.</td>\n        <td><code>{\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]}</code></td>\n    </tr>\n</table>\n\n##### Supported comparison operators\n\n<table>\n    <thead>\n        <tr>\n            <th>Attributes</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#notExist</code></td>\n        <td>Matches records that do not have given attribute.</td>\n        <td><code>{\"#notExist\":\"firstName\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#exist</code></td>\n        <td>Matches records that have given attribute.</td>\n        <td><code>{\"#exists\":\"firstName\"}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Strings</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified string.</td>\n        <td><code>{\"firstName\":\"John\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified string.</td>\n        <td><code>{\"#ne\":{\"firstName\":\"John\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#startsWith</code></td>\n        <td>Starts with a specified string.</td>\n        <td><code>{\"#startsWith\":{\"firstName\":\"John\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#endsWith</code></td>\n        <td>Ends with a specified string.</td>\n        <td><code>{\"#endsWith\":{\"firstName\":\"John\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#contains</code></td>\n        <td>Contains a specified string.</td>\n        <td><code>{\"#contains\":{\"firstName\":\"oh\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notContain</code></td>\n        <td>Does not contain a specified string.</td>\n        <td><code>{\"#notContain\":{\"firstName\":\"oh\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>At least one of the strings in a list.</td>\n        <td><code>{\"#in\":{\"firstName\":[\"John\",\"Jane\"]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Not any of the strings in a list.</td>\n        <td><code>{\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Dates</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified date.</td>\n        <td><code>{\"birthDate\":\"1987-07-10\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified date.</td>\n        <td><code>{\"#ne\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#eq (relative)</code></td>\n        <td>Will be in specified interval.</td>\n        <td><code>{\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt (relative)</code></td>\n        <td>Will be within a specified interval.</td>\n        <td><code>{\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt (relative)</code></td>\n        <td>Will be in more than a specified interval.</td>\n        <td><code>{\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#eq (relative) -</code></td>\n        <td>Was a specified interval ago.</td>\n        <td><code>{\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt (relative) -</code></td>\n        <td>Was within a specified interval ago.</td>\n        <td><code>{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt (relative) -</code></td>\n        <td>Was more than a specified interval ago.</td>\n        <td><code>{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt</code></td>\n        <td>Is before a specified date.</td>\n        <td><code>{\"#lt\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lte</code></td>\n        <td>Is before or equal to a specified date.</td>\n        <td><code>{\"#lte\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt</code></td>\n        <td>Is after a specified date.</td>\n        <td><code>{\"#gt\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gte</code></td>\n        <td>Is after or equal to a specified date.</td>\n        <td><code>{\"#gte\":{\"birthDate\":\"1987-07-10\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>Is equal to one of dates in a given list.</td>\n        <td><code>{\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Is not equal to any of dates in a given list.</td>\n        <td><code>{\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Integers</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified integer.</td>\n        <td><code>{\"data\\u0001counter\":1}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified integer.</td>\n        <td><code>{\"#ne\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt</code></td>\n        <td>Is less than a specified integer.</td>\n        <td><code>{\"#lt\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lte</code></td>\n        <td>Is less than or equal to a specified integer.</td>\n        <td><code>{\"#lte\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt</code></td>\n        <td>Is greater than a specified integer.</td>\n        <td><code>{\"#gt\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gte</code></td>\n        <td>Is greater than or equal to a specified integer.</td>\n        <td><code>{\"#gte\":{\"data\\u0001counter\":1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>Is equal to any of specified integers in a list.</td>\n        <td><code>{\"#in\":{\"data\\u0001counter\":[1,2,3]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Is not equal to any of specified integers in a list.</td>\n        <td><code>{\"#notIn\":{\"data\\u0001counter\":[1,2,3]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Decimals</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified decimal.</td>\n        <td><code>{\"data\\u0001price\":1.1}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Is not equal to a specified decimal.</td>\n        <td><code>{\"#ne\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lt</code></td>\n        <td>Is less than a specified decimal.</td>\n        <td><code>{\"#lt\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#lte</code></td>\n        <td>Is less than or equal to a specified decimal.</td>\n        <td><code>{\"#lte\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gt</code></td>\n        <td>Is greater than a specified decimal.</td>\n        <td><code>{\"#gt\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#gte</code></td>\n        <td>Is greater than or equal to a specified decimal.</td>\n        <td><code>{\"#gte\":{\"data\\u0001price\":1.1}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#in</code></td>\n        <td>Is equal to any of specified decimals in a list.</td>\n        <td><code>{\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notIn</code></td>\n        <td>Is not equal to any of specified decimals in a list.</td>\n        <td><code>{\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Booleans</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals to a specified boolean.</td>\n        <td><code>{\"data\\u0001happy\":true}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Not equal to a specified boolean.</td>\n        <td><code>{\"#ne\":{\"data\\u0001happy\":true}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Tags</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#contains</code></td>\n        <td>Contains a specified tag.</td>\n        <td><code>{\"#contains\":{\"tags\":\"SOME_TAG\"}}</code></td>\n    </tr>\n    <tr>\n        <td><code>#notContain</code></td>\n        <td>Does not contain a specified tag.</td>\n        <td><code>{\"#notContain\":{\"tags\":\"SOME_TAG\"}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Gender</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#eq</code></td>\n        <td>Equals a specified gender.</td>\n        <td><code>{\"gender\":\"MALE\"}</code></td>\n    </tr>\n    <tr>\n        <td><code>#ne</code></td>\n        <td>Does not equal a specified gender.</td>\n        <td><code>{\"#ne\":{\"gender\":\"FEMALE\"}}</code></td>\n    </tr>\n    <thead>\n        <tr>\n            <th>Lists</th>\n            <th>Description</th>\n            <th>Example</th>\n        </tr>\n    </thead>\n    <tr>\n        <td><code>#all</code></td>\n        <td>All items in the list match.</td>\n        <td><code>{\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}</code>\n        </td>\n    </tr>\n    <tr>\n        <td><code>#any</code></td>\n        <td>Any item in the list match.</td>\n        <td><code>{\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}</code>\n        </td>\n    </tr>\n</table>\n\n"
          example:
            '#and':
            - firstName: Alex
            - '#contains':
                tags: VIP Client
        events:
          type: array
          description: List of events that persons should match.
          items:
            $ref: '#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.EventClauseDto'
      required:
      - name
      title: SegmentUpdateDto
    e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AddTagToConversationApiRequest:
      type: object
      example:
        tagName: Tag Name
      properties:
        tagName:
          type: string
          description: Tag name identifier.
          maxLength: 100
          minLength: 0
      required:
      - tagName
      title: AddTagToConversationApiRequest
    900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantsRequest:
      type: object
      description: Request to add given participants to the Flow campaign.
      properties:
        participants:
          type: array
          description: Array of participants to add.
          items:
            $ref: '#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowParticipant'
          maxLength: 1000
        notifyUrl:
          type: string
          description: The URL on your callback server on which a report of operation results will be sent.
          maxLength: 1000
        callbackData:
          type: string
          description: Additional data will be passed in the request to your callback server along with the operation results report.
          maxLength: 2000
      required:
      - participants
      title: AddFlowParticipantsRequest
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel:
      type: object
      description: Duration information.
      properties:
        unit:
          $ref: '#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Unit'
        value:
          type: integer
          format: int32
          minimum: 1
      required:
      - unit
      - value
      title: DurationApiModel
    b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CallTimeoutApiModel:
      type: object
      example:
        inbound: 30
        outbound: 45
      properties:
        inbound:
          type: integer
          format: int32
          default: 30
          description: Inbound call timeout refers to the maximum duration a call rings before an agent answers it.
          maximum: 60
          minimum: 3
        outbound:
          type: integer
          format: int32
          default: 45
          description: Outbound call timeout refers to the maximum duration a call rings before customer or external number answers it.
          maximum: 60
          minimum: 3
      title: CallTimeoutApiModel
    1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignResponse:
      type: object
      properties:
        name:
          type: string
          description: Name of the campaign. Must be unique per account.
          examples:
          - My Campaign
          title: Name
        keywordSpec:
          type: object
          additionalProperties:
            type: string
          description: 'Specification of language-specific key phrases that users should pronounce during the campaign. This is a dictionary mapping language codes (ISO 639-1 with optional country code, e.g., ''en-US'', ''es-ES'') to the exact phrases users must say. Find the list of languages supported by Azure <a href="https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt">here</a> and the list of languages supported by Google <a href="https://cloud.google.com/speech-to-text/docs/speech-to-text-supported-languages">here</a>. The speech-to-text engine will compare user audio against these phrases for scoring. If left unspecified, the campaign will rely solely on image and/or audio matching. Phrases should be clear, pronounceable words or short sentences in the target language. '
          examples:
          - en-US: Hello
            es-ES: Hola
          title: Keywordspec
        activeFrom:
          type: string
          format: date-time
          description: Date and time when the campaign becomes active, in ISO 8601 format (e.g., 2023-10-01T00:00:00Z).
          title: Activefrom
        activeUntil:
          type: string
          format: date-time
          description: Date and time when the campaign ends, in ISO 8601 format (e.g., 2023-10-31T23:59:59Z).
          title: Activeuntil
        settings:
          $ref: '#/components/schemas/1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignSettings'
          default:
            maxDailyAttemptsPerUser: 30
            sttModelProvider: AZURE
            maxDailyAttemptsPerCampaign: 1500
          description: Campaign settings. You can regulate the number of attempts per user daily, as well as the total number of attempts in the campaign daily.
        imageUrl:
          type: string
          description: Image used for shape matching.
          examples:
          - https://www.example.com/image.jpg
          title: Imageurl
        id:
          type: string
          format: uuid
          description: Unique identifier of the campaign.
          title: Id
        accountId:
          type: string
          description: ID of the account that owns the campaign.
          title: Accountid
        dateCreated:
          type: string
          format: date-time
          description: Date and time when the campaign was created, in ISO 8601 format (e.g., 2023-10-01T00:00:00Z).
          title: Datecreated
      required:
      - accountId
      - activeFrom
      - activeUntil
      - id
      - name
      title: CampaignResponse
  responses:
    ApiError400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            errorCode: E400
            description: Request cannot be processed.
            action: Check the syntax, violations and adjust the request.
            violations: []
            resources: []
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiError'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E400</errorCode>\n  <description>Request cannot be processed.</description>\n  <action>Check the syntax, violations and adjust the request.</action>\n  <violations/>\n  <resources/>\n</ApiError>\n"
    ApiException500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: GENERAL_ERROR
                text: Something went wrong. Please contact support.
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>GENERAL_ERROR</messageId>\n      <text>Something went wrong. Please contact support.</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiException429:
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: TOO_MANY_REQUESTS
                text: Too many requests
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>TOO_MANY_REQUESTS</messageId>\n      <text>Too many requests</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiException404:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: NOT_FOUND
                text: Not found
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>NOT_FOUND</messageId>\n      <text>Not found</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiError429:
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            errorCode: E429
            description: Too many requests sent.
            action: Check request rate limit specified in the API endpoint documentation resource.
            violations: []
            resources:
            - name: Throttling handling errors
              url: https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiError'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E429</errorCode>\n  <description>Too many requests sent.</description>\n  <action>Check request rate limit specified in the API endpoint documentation resource.</action>\n  <violations/>\n  <resources>\n    <resource>\n      <name>Throttling handling errors</name>\n      <url>https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors</url>\n    </resource>\n  </resources>\n</ApiError>\n"
    ApiException400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: BAD_REQUEST
                text: Bad request
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiError403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            errorCode: E403
            description: Insufficient permissions to access the requested resource.
            action: Repeat the request with new or different credentials.
            violations: []
            resources:
            - name: API Scopes
              url: https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiError'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E403</errorCode>\n  <description>Insufficient permissions to access the requested resource.</description>\n  <action>Repeat the request with new or different credentials.</action>\n  <violations/>\n  <resources>\n    <resource>\n      <name>API Scopes</name>\n      <url>https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes</url>\n    </resource>\n  </resources>\n</ApiError>\n"
    ApiException401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: UNAUTHORIZED
                text: Unauthorized
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>UNAUTHORIZED</messageId>\n      <text>Unauthorized</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiException403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: FORBIDDEN
                text: Forbidden
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>FORBIDDEN</messageId>\n      <text>Forbidden</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiError404:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            errorCode: E404
            description: Not found - request URL doesn't exist on the API server or resource is not found.
            action: Check the resources and adjust your request.
            violations: []
            resources: []
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiError'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E404</errorCode>\n  <description>Not found - request URL doesn't exist on the API server or resource is not found.</description>\n  <action>Check the resources and adjust your request.</action>\n  <violations/>\n  <resources/>\n</ApiError>\n"
    ApiError401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            errorCode: E401
            description: The request lacks valid authentication credentials for the requested resource.
            action: Check the resources and adjust authentication credentials.
            violations: []
            resources:
            - name: API Authentication
              url: https://www.infobip.com/docs/essentials/api-authentication
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiError'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E401</errorCode>\n  <description>The request lacks valid authentication credentials for the requested resource.</description>\n  <action>Check the resources and adjust authentication credentials.</action>\n  <violations/>\n  <resources>\n    <resource>\n      <name>API Authentication</name>\n      <url>https://www.infobip.com/docs/essentials/api-authentication</url>\n    </resource>\n  </resources>\n</ApiError>\n"
    ApiError500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            errorCode: E500
            description: Something went wrong.
            action: Contact the support.
            violations: []
            resources: []
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiError'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E500</errorCode>\n  <description>Something went wrong.</description>\n  <action>Contact the support.</action>\n  <violations/>\n  <resources/>\n</ApiError>\n"
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: 'This is the most secure authorization type and the one with the most flexibility.


        API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can

        be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.

        Finally, the loss of an API key is easily manageable.


        You can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically

        with [dedicated API](#platform-&-connectivity/settings).


        API key Authorization header example:


        ```shell

        Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9

        ```

        '
      name: Authorization
      in: header
    Basic:
      type: http
      description: 'Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated

        with the Basic type.


        In this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic

        authentication header can be constructed in three steps:


        * Username and password are concatenated using the colon `(:)` as a separator `username:password`.

        * The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.

        * Encoded string is added as credentials after the `"Basic "` type.


        Example:


        ```shell

        Username: "Aladdin"

        Password: "openSesame"


        Concatenated string: "Aladdin:openSesame"


        Base64 encoded string: "QWxhZGRpbjpvcGVuU2VzYW1l"


        Authorization header: "Basic QWxhZGRpbjpvcGVuU2VzYW1l"

        ```


        > **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding

        > strings.

        '
      scheme: basic
    IBSSOTokenHeader:
      type: apiKey
      description: 'This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip

        credentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be

        used to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually

        terminated by making an appropriate API call.


        You can find more details on the creation and behavior of the session at

        the [dedicated documentation page](#platform-connectivity/account-management/create-session).


        After obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:


        ```shell

        Authorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394

        ```

        '
      name: Authorization
      in: header
    OAuth2:
      type: oauth2
      description: 'Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain

        the access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.

        You can use the token to authorize your API calls until it expires. You can find out more about the process in

        the [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).


        You can include your access token in the Authorization HTTP request header like this:


        ```http

        Authorization: Bearer <access_token>

        ```'
      flows:
        clientCredentials:
          tokenUrl: https://api.infobip.com/auth/1/oauth2/token
          scopes: {}