indigitall Customer Service Segment API

openapi: 3.2.0
info:
  version: 2.0.0
  title: INDIGITALL Customer Service Segment API
  x-logo:
    url: https://console.indigitall.com/images/logo_verdeblanco@2x.png
    backgroundColor: '#0F3B7A'
  description: '### Introduction:

    This documentation describes every endpoint of Indigitall''s API v2


    API BASE URL: https://api.indigitall.com/v2


    ### Authentication:


    Most of the endpoints of the API needs an Authorization header.


    There are two Authorization ways:


    - If your intention is to manage API calls with a server-side script you have to create a Server key through Indigitall''s console.


    You can set the following Authorization Header : ''Authorization: ServerKey {ServerKey}''

    - If your intention is to integrate this API for front-end users POST /auth endpoint authorizes a user and returns an access token.


    You can set the following Authorization Header : ''Authorization: Bearer {Token}'''
servers:
- url: https://api.indigitall.com/v2
security:
- Authorization: []
tags:
- name: customer-service-segment
  x-displayName: Customer service - Segment
  description: Customer service endpoints
paths:
  /cs/segment:
    get:
      tags:
      - customer-service-segment
      summary: Get all segments
      x-eov-operation-handler: segmentController
      x-gateway-endpoint: customerService
      operationId: csGetAllSegments
      parameters:
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      - in: query
        name: limit
        required: false
        description: results per page
        schema:
          type: integer
          default: 100
      - in: query
        name: page
        required: false
        description: filter by page
        schema:
          type: integer
          minimum: 0
          default: 0
      - in: query
        name: find
        required: false
        description: filter by name, url
        schema:
          type: string
      - in: query
        name: orderBy
        required: false
        description: "Order of the results:\n\n  * a-z - Order by name ascending. From A to Z.\n  * z-a - Order by name descending. From Z to A.\n  * 1-9 - Order by id ascending.\n  * 9-1 - Order by id descending.\n  * Date ascending - Order by created_at ascending.\n  * Date descending - Order by created_at descending.\n"
        schema:
          type: string
          enum:
          - a-z
          - z-a
          - 1-9
          - 9-1
          - Date ascending
          - Date descending
          default: Date descending
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_SegmentListResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
    post:
      tags:
      - customer-service-segment
      summary: Creates a segment
      description: 'Creates a segment entity.


        A segment represents a collection of customers filtered by specified conditions, which can be used for targeted campaigns, analytics, or custom workflows.'
      x-eov-operation-handler: segmentController
      x-gateway-endpoint: customerService
      operationId: csPostSegment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CS_SegmentPostRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_SegmentResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Segment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_SEGMENT_NOT_FOUND
                message: Segment not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
  /cs/segment/{id}:
    delete:
      tags:
      - customer-service-segment
      summary: Delete one segment by id
      x-eov-operation-handler: segmentController
      x-gateway-endpoint: customerService
      operationId: csDeleteSegment
      parameters:
      - in: path
        name: id
        schema:
          type: number
        required: true
        description: Numeric ID of the segment to get
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      responses:
        '200':
          $ref: '#/components/responses/CS_DeleteResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Segment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_SEGMENT_NOT_FOUND
                message: Segment not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
    get:
      tags:
      - customer-service-segment
      summary: Gets one segment by id
      x-eov-operation-handler: segmentController
      x-gateway-endpoint: customerService
      operationId: csGetSegment
      parameters:
      - in: path
        name: id
        schema:
          type: number
        required: true
        description: Numeric ID of the segment to get
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_SegmentResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Segment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_SEGMENT_NOT_FOUND
                message: Segment not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
    put:
      tags:
      - customer-service-segment
      summary: Update one segment by id
      description: Update one segment by id.
      x-eov-operation-handler: segmentController
      x-gateway-endpoint: customerService
      operationId: csPutSegment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CS_SegmentPutRequest'
        required: true
      parameters:
      - in: path
        name: id
        schema:
          type: number
        required: true
        description: Numeric ID of the segment to get
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_SegmentResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Segment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_SEGMENT_NOT_FOUND
                message: Segment not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
  /cs/segment/{id}/export/csv:
    get:
      tags:
      - customer-service-segment
      summary: Download customers CSV for a segment
      description: 'Streams a CSV file containing customer data for the specified segment.


        **Note:** This process may take several minutes depending on the segment size,

        as the CSV is generated on-the-fly. The connection may remain open for a long time.'
      x-eov-operation-handler: segmentController
      x-gateway-endpoint: customerService
      operationId: csExportSegmentCsv
      parameters:
      - in: path
        name: id
        schema:
          type: number
        required: true
        description: Numeric ID of the segment to get
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      responses:
        '200':
          description: Successful CSV data
          content:
            text/csv:
              schema:
                type: string
                format: binary
              example: 'id,createdAt,customerId,enabled,smsEnabled,emailEnabled,pushEnabled,chatEnabled

                159579,2025-03-03T16:20:55.856Z,d9702454-25d3-4a75-8cc4-9276ea3fc5ed,true,true,true,false,false

                279379,2025-03-03T16:21:02.054Z,4e79f7d7-c6ed-4ff2-9766-f2b7ea1a1552,true,false,true,true,false

                251863,2025-03-03T16:21:00.610Z,f2b95922-231e-4d60-b179-8e08f1ec71fe,true,true,true,false,true

                '
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Segment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_SEGMENT_NOT_FOUND
                message: Segment not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
  /cs/segment/{id}/list:
    get:
      tags:
      - customer-service-segment
      summary: Retrieves customers for a segment
      description: Returns a paginated list of customers belonging to the segment identified by `{id}`. Supports optional pagination parameters (`page`, `pageSize`).
      x-eov-operation-handler: segmentController
      x-gateway-endpoint: customerService
      operationId: csGetSegmentList
      parameters:
      - in: path
        name: id
        schema:
          type: number
        required: true
        description: Numeric ID of the segment to get
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      - in: query
        name: limit
        required: false
        description: results per page
        schema:
          type: integer
          default: 100
      - in: query
        name: page
        required: false
        description: filter by page
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_SegmentListCustomersResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Segment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_SEGMENT_NOT_FOUND
                message: Segment not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
components:
  responses:
    CS_Forbidden:
      description: Operation forbidden for your user
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CS_ErrorSchema'
          example:
            statusCode: 403
            errorCode: CS_FORBIDDEN
            message: Operation forbidden
    CS_ServerErrorResponse:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CS_ErrorSchema'
          example:
            statusCode: 500
            errorCode: CS_SERVER_ERROR
            message: Server error
    CS_BadRequestResponse:
      description: Parameter is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CS_ErrorSchema'
          example:
            statusCode: 400
            errorCode: CS_PARAMETER_MISSING_OR_INVALID
            message: Parameter is missing or invalid
    CS_DeleteResponse:
      description: Deleted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CS_OKSchema'
          example:
            statusCode: 200
            message: OK
  schemas:
    CS_SegmentListCustomersResponse:
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        count:
          type: integer
          description: Number of records
        data:
          type: array
          description: Array of customers
          items:
            $ref: '#/components/schemas/CS_SegmentCustomerObject'
    CS_OKSchema:
      required:
      - statusCode
      - message
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
    CS_SegmentObject:
      type: object
      properties:
        id:
          type: integer
          description: segment identifier
        name:
          type: string
          description: Name for segment. Should be unique.
        applicationId:
          type: number
          description: application id
        filterDefinition:
          $ref: '#/components/schemas/CS_SegmentFilterDefinition'
        estimatedCount:
          type:
          - number
          - 'null'
          description: Estimated customers count associated to the segment
        description:
          type:
          - string
          - 'null'
          description: Optional description for the segment.
    CS_SegmentListResponse:
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        count:
          type: integer
          description: Number of records
        data:
          type: array
          description: Array of segments
          items:
            $ref: '#/components/schemas/CS_SegmentObject'
    CS_CustomerServicesObject:
      properties:
        smsEnabled:
          type: boolean
          description: If sms enabled
        emailEnabled:
          type: boolean
          description: If email enabled
        pushEnabled:
          type: boolean
          description: If push enabled
        chatEnabled:
          type: boolean
          description: If chat enabled
    CS_SegmentPostRequest:
      description: Schema for create a new segment
      type: object
      required:
      - applicationId
      - filterDefinition
      - name
      properties:
        name:
          type: string
          description: Name for segment
        applicationId:
          type: number
          description: application id
        description:
          type:
          - string
          - 'null'
          description: Optional description for the segment.
        filterDefinition:
          $ref: '#/components/schemas/CS_SegmentFilterDefinition'
    CS_SegmentPutRequest:
      description: Schema for update a segment
      type: object
      properties:
        name:
          type: string
          description: Name for segment
        description:
          type:
          - string
          - 'null'
          description: Optional description for the segment.
        filterDefinition:
          $ref: '#/components/schemas/CS_SegmentFilterDefinition'
    CS_SegmentFilterDefinition:
      type: object
      description: "* Defines the filter rules for querying or segmenting data. The filter includes\n  a top-level operator (`op`) and an array of conditions (`conditions`).\n\n* Top-level operator:\n\n  - `op`: currently, only `\"OR\"` is supported.\n\n* Condition types:\n\n  - `field`: compares a field against a value using operators like `lt`, `gt`, `gte`, `lte`, `eq`, `neq`.\n    - For `lt`, `gt`, `gte`, `lte`, only numbers or dates (ISO 8601 format) are allowed.\n    - `eq` and `neq` accept numbers, strings or booleans.\n    - For `boolean` fields, filtering by `eq: false` matches **only** customers whose field is explicitly `false`; customers without a value (null/absent) are not returned. Use `isnull` to match those.\n    - `isnull` / `isnotnull`: field has no value / field has a value (no value required).\n    - `filterOperator`: optional, defines how to combine multiple fields within the same condition or operations inside fields('AND' or 'OR'). Default: 'AND'.\n\n* Params example for a simple field condition:\n\n  ```\n  {\n    \"op\": \"OR\",\n    \"conditions\": [\n      {\n        \"type\": \"field\",\n        \"cond\": {\n          \"age\": {\n            \"gt\": 30,\n            \"lt\": 90,\n            \"filterOperator\": \"AND\"\n          },\n          \"signupDate\": {\n            \"lte\": \"2025-12-31T23:59:59Z\"\n          }\n        },\n        \"filterOperator\": \"AND\"\n      },\n      {\n        \"type\": \"field\",\n        \"cond\": {\n          \"city\": {\n            \"eq\": \"Madrid\"\n          },\n          \"premium\": {\n            \"eq\": true\n          }\n        },\n        \"filterOperator\": \"OR\"\n      }\n    ]\n  }\n  ```\n\n* Notes:\n\n  - Each filter can contain multiple conditions.\n  - The number of field conditions is limited to avoid overly complex filters.\n  - `filterOperator` determines how fields are combined within each condition:\n    - `\"AND\"` (default): customer must match ALL fields in that condition\n    - `\"OR\"`: customer must match AT LEAST ONE field in that condition\n    - If only one field is present, filterOperator has no effect\n"
    CS_SegmentResponse:
      required:
      - data
      - message
      - statusCode
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        data:
          $ref: '#/components/schemas/CS_SegmentObject'
    CS_SegmentCustomerObject:
      required:
      - customerId
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
          description: internal id
        customerId:
          type: string
          description: external customer id
        applicationId:
          type: number
          description: application id
        services:
          $ref: '#/components/schemas/CS_CustomerServicesObject'
        createdAt:
          type: string
          format: date-time
        enabled:
          type: boolean
          description: if customer enabled
    CS_ErrorSchema:
      required:
      - message
      - statusCode
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        errorCode:
          type: string
          enum:
          - CS_CUSTOMER_NOT_ENABLED
          - CS_CUSTOMER_NOT_FOUND
          - CS_CUSTOMER_ID_IN_USE
          - CS_CUSTOMER_WITH_NO_FIELDS
          - CS_CUSTOMER_BAD_FORMAT_FIELD
          - CS_CUSTOMERS_NOT_FOUND
          - CS_CUSTOMERS_HAVE_ERRORS
          - CS_CUSTOMERS_SOME_HAVE_ERRORS
          - CS_APPLICATION_WITH_NO_FIELDS
          - CS_CUSTOMER_FIELD_ALREADY_EXISTS
          - CS_INVALID_CUSTOMER_FIELD_NAME
          - CS_CUSTOMER_FIELD_NOT_FOUND
          - CS_API_GATEWAY_TOKEN_NOT_VALID
          - CS_ERROR_PROCESSING_GATEWAY_TOKEN
          - CS_AUTHORIZATION_FORMAT_ERROR
          - CS_NOT_VALID_IP
          - CS_NOT_VALID_KEY
          - CS_SERVER_ERROR
          - CS_TOO_MANY_REQUEST
          - CS_CAMPAING_ID_NOT_FOUND
          - CS_CSV_FORMAT_NOT_SUPPORTED
          - CS_CSV_WITH_NO_CUSTOMERS
          - CS_CSV_WITH_NO_CUSTOMER_ID_FIELD
          - CS_CSV_WITH_NO_CUSTOMER_FIELDS
          - CS_INCORRECT_SCHEDULE_AT_DATE
          - CS_CUSTOMER_JOURNEY_NOT_FOUND
          - CS_CUSTOMER_JOURNEY_TEMPLATE_NOT_FOUND
          - CS_CUSTOMER_JOURNEY_TEMPLATE_DISABLED
          - CS_FIELD_VALUE_INVALID
          - CS_FIELD_HISTORY_NOT_ALLOWED
          - CS_FIELD_AGGREGATION_IS_MANDATORY
          - CS_FIELD_AGGREGATION_WINDOW_FORBIDDEN
          - CS_FIELD_AGGREGATION_WINDOW_REQUIRED
          - CS_FIELD_AGGREGATION_WINDOW_NOT_VALID
          - CS_FIELD_SOURCE_EVENT_FIELD_NOT_VALID
          - CS_COMPUTED_ENABLED_REQUIRED
          - CS_CUSTOMER_JOURNEY_STATE_NOT_FOUND
          - CS_CUSTOMER_JOURNEY_COULD_NOT_BE_EDITED_AFTER_BE_ENABLED
          - CS_PARAMETER_MISSING_OR_INVALID
          - CS_RESOURCE_NOT_FOUND
          - CS_JOURNEY_NOT_FOUND
          - CS_JOURNEY_ALREADY_ENABLED_OR_TERMINATED
          - CS_JOURNEY_ENABLED
          - CS_JOURNEY_NOT_RUNNING
          - CS_JOURNEY_INVALID
          - CS_JOURNEY_CANT_ADD_CUSTOMERS
          - CS_JOURNEY_STATE_INVALID
          - CS_FORBIDDEN
          - CS_BRANCH_STATS_NOT_FOUND
          - CS_JOURNEY_STATE_STATS_NOT_FOUND
          - CS_STATS_NOT_FOUND
          - CS_BAD_REQUEST
          - CS_INVALID_FILTER
          - CS_INVALID_ORDER
          - CS_CUSTOMER_DATA_CSV_EXPORT_NOT_ENABLED
          - CS_WEBHOOK_TEMPLATE_NOT_FOUND
          - CS_WEBHOOK_TEMPLATE_BODY_NOT_ALLOWED_FOR_GET
          - CS_WEBHOOK_TEMPLATE_URL_INVALID
          - CS_WEBHOOK_TEMPLATE_BODY_INVALID
          - CS_SEGMENT_NOT_FOUND
          - CS_SEGMENT_INVALID
          - CS_SEGMENT_ALREADY_EXISTS
          - CS_AUDIENCE_LIST_NOT_FOUND
          - CS_AUDIENCE_LIST_INVALID
          - CS_AUDIENCE_LIST_ALREADY_EXISTS
          - CS_CDP_EVENT_NOT_FOUND
          - CS_CDP_EVENT_ALREADY_EXISTS
          - CS_CDP_EVENT_TYPE_INVALID
          - CS_CDP_EVENT_TYPE_RETENTION_DAYS_LIMIT_EXCEEDED
          - CS_CDP_EVENT_TYPE_EVENT_HISTORY_NOT_ALLOWED
          - CS_CDP_EVENT_FIELD_LIMIT_REACHED
          - CS_CDP_EVENT_TEMPLATE_NOT_FOUND
          - CS_CDP_EVENTS_INGESTION_NOT_ENABLED
          - CS_CDP_FIELD_AGGREGATED_NOT_ENABLED
          - CS_INVALID_FIELD_ROLE
          - CS_FIELD_ROLE_VALUE_TYPE_MISMATCH
          - CS_MANUAL_COMPUTE_LIMIT_EXCEEDED
          description: '* `CS_CUSTOMER_NOT_ENABLED` - The customer feature is not available for this application

            * `CS_CUSTOMER_NOT_FOUND` - Customer not found

            * `CS_CUSTOMER_ID_IN_USE` - External code is already in use

            * `CS_CUSTOMER_WITH_NO_FIELDS` - This customer id has no custom fields

            * `CS_APPLICATION_WITH_NO_FIELDS` - This application id has no custom fields

            * `CS_CUSTOMER_FIELD_ALREADY_EXISTS` - Customer field already exists

            * `CS_INVALID_CUSTOMER_FIELD_NAME` - Invalid customer field name

            * `CS_CUSTOMER_FIELD_NOT_FOUND` - Customer field name not found

            * `CS_API_GATEWAY_TOKEN_NOT_VALID` - Gateway token is not valid

            * `CS_ERROR_PROCESSING_GATEWAY_TOKEN` - Error processing gateway token

            * `CS_AUTHORIZATION_FORMAT_ERROR` - Authorization is not present or has no right format

            * `CS_NOT_VALID_IP` - IP is not valid

            * `CS_NOT_VALID_KEY` - Key is not valid

            * `CS_SERVER_ERROR` - Server Error

            * `CS_TOO_MANY_REQUEST` - Too many request for your account, try again in ${seconds} seconds

            * `CS_CAMPAING_ID_NOT_FOUND` - Campaign id not found

            * `CS_CSV_FORMAT_NOT_SUPPORTED` - Some error in the csv format

            * `CS_CSV_WITH_NO_CUSTOMERS` - There are no customers in this CSV

            * `CS_CSV_WITH_NO_CUSTOMER_ID_FIELD` - customerId field not found in this CSV

            * `CS_COMPUTED_ENABLED_REQUIRED` - The computedEnabled field is required for computed fields

            * `CS_CSV_WITH_NO_CUSTOMER_FIELDS` - Customer fields not found in headers

            * `CS_INCORRECT_SCHEDULE_AT_DATE` - The date must be greater than the current date

            * `CS_CUSTOMER_JOURNEY_NOT_FOUND` - Customer Journey not found

            * `CS_CUSTOMER_JOURNEY_TEMPLATE_NOT_FOUND` - Customer Journey Template not found

            * `CS_CUSTOMER_JOURNEY_TEMPLATE_DISABLED` - Customer Journey Template is disabled

            * `CS_FIELD_VALUE_INVALID` - The value of a field for a customer has been set to the wrong value or format

            * `CS_FIELD_HISTORY_NOT_ALLOWED` - Field event history not allowed

            * `CS_FIELD_AGGREGATION_IS_MANDATORY` - Field aggregation is mandatory

            * `CS_FIELD_AGGREGATION_WINDOW_FORBIDDEN` - Field aggregation window is forbidden

            * `CS_FIELD_AGGREGATION_WINDOW_REQUIRED` - Field aggregation window is required

            * `CS_FIELD_AGGREGATION_WINDOW_NOT_VALID` - Field aggregation window is not valid format

            * `CS_FIELD_SOURCE_EVENT_FIELD_NOT_VALID` - Field source event field is not valid and required

            * `CS_CUSTOMER_JOURNEY_STATE_NOT_FOUND` - Customer Journey State not found

            * `CS_CUSTOMER_JOURNEY_COULD_NOT_BE_EDITED_AFTER_BE_ENABLED` - Customer Journey could not be edited after be enabled

            * `CS_PARAMETER_MISSING_OR_INVALID` - Some parameter is invalid or missing

            * `CS_RESOURCE_NOT_FOUND` - Resource not found

            * `CS_JOURNEY_NOT_FOUND` - Journey not found

            * `CS_JOURNEY_ALREADY_ENABLED_OR_TERMINATED` - The journey is running or has been running and has already stopped.

            * `CS_JOURNEY_ENABLED` - The journey is running

            * `CS_JOURNEY_NOT_RUNNING` - The journey is not running

            * `CS_JOURNEY_INVALID` - Invalid configuration of journey

            * `CS_JOURNEY_CANT_ADD_CUSTOMERS` - The journey does not allow to add customers

            * `CS_JOURNEY_STATE_INVALID` - Invalid parameters of journey state

            * `CS_FORBIDDEN` - Forbidden

            * `CS_BRANCH_STATS_NOT_FOUND` - Statistics not found

            * `CS_JOURNEY_STATE_STATS_NOT_FOUND` - Statistics not found

            * `CS_STATS_NOT_FOUND` - Statistics not found

            * `CS_BAD_REQUEST` - Bad request

            * `CS_INVALID_FILTER` - Invalid filter

            * `CS_INVALID_ORDER` - Invalid order

            * `CS_CUSTOMER_DATA_CSV_EXPORT_NOT_ENABLED` - Customer data CSV export feature not enabled for this application

            * `CS_WEBHOOK_TEMPLATE_NOT_FOUND` - Webhook template not found

            * `CS_WEBHOOK_TEMPLATE_BODY_NOT_ALLOWED_FOR_GET` - Webhook template body not allowed for GET requests

            * `CS_WEBHOOK_TEMPLATE_URL_INVALID` - Webhook template url is invalid

            * `CS_WEBHOOK_TEMPLATE_BODY_INVALID` - Webhook template body is invalid

            * `CS_SEGMENT_NOT_FOUND` - Segment not found

            * `CS_SEGMENT_INVALID` - Invalid configuration of segment

            * `CS_SEGMENT_ALREADY_EXISTS` - Segment already exists

            * `CS_AUDIENCE_LIST_NOT_FOUND` - Audience list not found

            * `CS_AUDIENCE_LIST_INVALID` - Invalid configuration of audience list

            * `CS_AUDIENCE_LIST_ALREADY_EXISTS` - Audience list already exists

            * `CS_CDP_EVENT_AGGREGATED_NOT_ENABLED` - CDP Event aggregated not enabled

            * `CS_CDP_EVENT_NOT_FOUND` - CDP Event not found

            * `CS_CDP_EVENT_ALREADY_EXISTS` - CDP Event already exists

            * `CS_CDP_EVENT_TYPE_INVALID` - Invalid configuration of CDP Event Type

            * `CS_CDP_EVENT_TYPE_RETENTION_DAYS_LIMIT_EXCEEDED` - CDP Event Type retention days limit exceeded

            * `CS_CDP_EVENT_TYPE_EVENT_HISTORY_NOT_ALLOWED` - CDP Event Type event history not allowed

            * `CS_CDP_EVENT_FIELD_LIMIT_REACHED` - CDP Event Type field limit reached

            * `CS_CDP_EVENT_TEMPLATE_NOT_FOUND` - CDP Event Template not found

            * `CS_CDP_EVENTS_INGESTION_NOT_ENABLED` - CDP Events ingestion not enabled

            * `CS_CDP_FIELD_AGGREGATED_NOT_ENABLED` - CDP Field aggregated not enabled

            * `CS_INVALID_FIELD_ROLE` - Invalid field role value

            * `CS_FIELD_ROLE_VALUE_TYPE_MISMATCH` - Field role requires a different valueType

            * `CS_MANUAL_COMPUTE_LIMIT_EXCEEDED` - Monthly limit of manual compute executions exceeded

            '
        message:
          type: string
          description: Error message
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorization for accesing endpoints , must be in one of the following format:

        - **Bearer {token}**

        - **ServerKey {key}**

        '
    MultimediaJWT:
      type: apiKey
      in: query
      name: jwt
      description: JWT token for signed URL multimedia authentication (query param)
x-tagGroups:
- name: Chat Service
  tags:
  - chat-configuration
  - chat-channel
  - chat-contact
  - chat-integration
  - chat-task
  - chat-campaign
  - chat-send
  - chat-multimedia
  - chat-slicing
  - chat-tag
  - chat-contact-list
  - chat-cc-agent
  - chat-cc-permissions-profile
  - chat-cc-weekly-schedule
  - chat-cc-special-days-schedule
  - chat-cc-conversation
  - chat-cc-agent-group
  - chat-cc-contact-comment
  - chat-cc-form
  - chat-stats
  - chat-internal
- name: Customer Service
  tags:
  - customer-service-adviser
  - customer-service-customer
  - customer-service-customer-csv
  - customer-service-customer-field
  - customer-service-customer-journey
  - customer-service-customer-journey-template
  - customer-service-customer-journey-control
  - customer-service-customer-send
  - customer-service-stats
  - customer-service-webhook-template
  - customer-service-segment
  - customer-service-audience
  - customer-service-application
  - customer-service-journeywaitqueue
  - customer-service-task
  - customer-service-cdpeventtype
  - customer-service-cdpeventtypetemplate
  - customer-service-internal
- name: Email Service
  tags:
  - es-configuration
  - es-configurationDomain
  - es-configurationDomainEmail
  - es-footer
  - es-audience
  - es-contact
  - es-category
  - es-campaign
  - es-campaign-block
  - es-campaign block-column
  - es-campaign-multimedia


# --- truncated at 32 KB (70 KB total) ---
# Full source: https://artifacts.apis.io/indigitall/openapi/indigitall-customer-service-segment-api-openapi.yml