indigitall Customer Service Customer Journey Control API

openapi: 3.2.0
info:
  version: 2.0.0
  title: INDIGITALL Customer Service Customer Journey Control 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-customer-journey-control
  x-displayName: Customer service - Journey Control
  description: Customer service endpoints
paths:
  /cs/journey/{id}/addaudience:
    parameters:
    - in: path
      name: id
      required: true
      description: journey id
      schema:
        type: integer
    put:
      tags:
      - customer-service-customer-journey-control
      summary: Put a list of audiences to a journey that is already running
      description: 'Put a list of audiences to a journey that is already running


        The customer journey must have an IN state of type IN_LIST


        If any of the customers is already in the journey, the system will discard that customer'
      x-eov-operation-handler: journeyControlController
      x-gateway-endpoint: customerService
      operationId: csStartJourneyAudienceList
      parameters:
      - in: query
        name: testingMode
        description: 'Run the journey with a list of customers in test mode.


          The journey must be in IDLE mode.

          '
        schema:
          type: boolean
          default: false
      requestBody:
        $ref: '#/components/requestBodies/CS_AddAudience'
      responses:
        '200':
          $ref: '#/components/responses/CS_OKResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          $ref: '#/components/responses/CS_NotFoundResponse'
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
  /cs/journey/{id}/addcsv:
    parameters:
    - in: path
      name: id
      required: true
      description: journey id
      schema:
        type: integer
    put:
      tags:
      - customer-service-customer-journey-control
      summary: Put a list of customers to a journey that is already running from a CSV file
      description: 'Put a list of customers to a journey that is already running


        The customer journey must have an IN state of type IN_LIST


        If any of the customers is already in the journey, the system will discard that customer endpoint may return an error.'
      x-eov-operation-handler: journeyControlController
      x-gateway-endpoint: customerService
      operationId: csStartJourneyCSV
      parameters:
      - in: query
        name: testingMode
        description: 'Run the journey with a list of customers in test mode.


          The journey must be in IDLE mode.

          '
        schema:
          type: boolean
          default: false
      requestBody:
        $ref: '#/components/requestBodies/CS_AddCSV'
      responses:
        '200':
          $ref: '#/components/responses/CS_OKResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          $ref: '#/components/responses/CS_NotFoundResponse'
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
  /cs/journey/{id}/addlist:
    parameters:
    - in: path
      name: id
      required: true
      description: journey id
      schema:
        type: integer
    put:
      tags:
      - customer-service-customer-journey-control
      summary: Put a list of customers to a journey that is already running
      description: 'Put a list of customers to a journey that is already running


        The customer journey must have an IN state of type IN_LIST


        If any of the customers is already in the journey, the system will discard that customer'
      x-eov-operation-handler: journeyControlController
      x-gateway-endpoint: customerService
      operationId: csStartJourneyList
      parameters:
      - in: query
        name: testingMode
        description: 'Run the journey with a list of customers in test mode.


          The journey must be in IDLE mode.

          '
        schema:
          type: boolean
          default: false
      requestBody:
        $ref: '#/components/requestBodies/CS_AddList'
      responses:
        '200':
          $ref: '#/components/responses/CS_OKResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          $ref: '#/components/responses/CS_NotFoundResponse'
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
  /cs/journey/{id}/start:
    parameters:
    - in: path
      name: id
      required: true
      description: journey id
      schema:
        type: integer
    put:
      tags:
      - customer-service-customer-journey-control
      summary: Starts a journey
      description: 'Starts a journey

        Before starting a journey, a check of the journey and all its statuses is performed. If any error is found an error 400 will be returned with the details.'
      x-eov-operation-handler: journeyControlController
      x-gateway-endpoint: customerService
      operationId: csStartJourney
      responses:
        '200':
          $ref: '#/components/responses/CS_OKResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestJourneyCheckResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          $ref: '#/components/responses/CS_NotFoundResponse'
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
  /cs/journey/{id}/stop:
    parameters:
    - in: path
      name: id
      required: true
      description: journey id
      schema:
        type: integer
    put:
      tags:
      - customer-service-customer-journey-control
      summary: Stops a journey execution
      description: 'Stops a journey execution


        When a job is finished it cannot be restarted.'
      x-eov-operation-handler: journeyControlController
      x-gateway-endpoint: customerService
      operationId: csStopJourney
      responses:
        '200':
          $ref: '#/components/responses/CS_OKResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          $ref: '#/components/responses/CS_NotFoundResponse'
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
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_BadRequestJourneyCheckResponse:
      description: Parameter is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CS_ErrorJourneyCheckSchema'
          example:
            statusCode: 400
            errorCode: CS_JOURNEY_STATE_INVALID
            message: Bad journey state format
            errors:
            - code: INVALID_CHILD_NOEXISTS
              stateId: 23
    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_NotFoundResponse:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CS_ErrorSchema'
          example:
            statusCode: 404
            errorCode: CS_RESOURCE_NOT_FOUND
            message: Resource not found
    CS_OKResponse:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CS_OKSchema'
          example:
            statusCode: 200
            message: OK
    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
  requestBodies:
    CS_AddAudience:
      content:
        application/json:
          schema:
            type: object
            properties:
              audienceListIds:
                type: array
                minItems: 1
                description: 'Audience List IDs to process

                  '
                items:
                  type: number
    CS_AddCSV:
      content:
        multipart/form-data:
          schema:
            required:
            - file
            type: object
            properties:
              file:
                description: "A `.csv` file containing a list of customer IDs and optionally custom context fields.\n**Requirements:**\n  - The CSV **must include a column with the header `customerId`**, which contains the customer IDs you want to target.\n  - You **may include a column `concurrencyExecutionId`** if the journey supports concurrency. If not provided, the system will generate a random for each customer.\n  - You may include **any other columns**, which will be interpreted as dynamic context fields (`contextKeys`) with their corresponding values.\n\nExample customer list:\n~~~\n  customerId,offerBank,subscriptionLevel\n  be5d3f02f48647e2bd985128e1c4b065,300.00,premium\n  be5d78f2f48647e2bd985128e1c4b066,256.00,basic\n  be5d3f02a34547e2bd981234wqe34241,220.00,standard\n~~~\n~~~\n  customerId,concurrencyExecutionId,offerBank\n  be5d3f02a34547e2bd981234wqe34241,xyz789,220.00\n  be5d3f02f48647e2bd985128e1c4b065,,300.00\n~~~\n**Notes:**\n  - The order of columns does not matter, except that `customerId` is required.\n  - Any column besides `customerId` and `concurrencyExecutionId` is treated as a dynamic context field.\n"
                type: string
                format: binary
    CS_AddList:
      content:
        application/json:
          schema:
            type: object
            properties:
              customers:
                description: "Can be either:\n  - **Deprecated:** array of string customer IDs.\n  - Array of customer objects with context (preferred).\n\n**Only `customers` OR `customersWithContext` should be provided.**\n"
                oneOf:
                - type: array
                  items:
                    type: string
                - type: array
                  items:
                    type: object
                    required:
                    - customerId
                    properties:
                      customerId:
                        type: string
                        description: Alphanumeric customer ID.
                      contextValues:
                        type: object
                        description: Dynamic context key-value pairs.
                      concurrencyExecutionId:
                        type: string
                        maxLength: 40
                        description: 'Optional. Unique identifier used only if the journey supports concurrency. If not provided, the system will automatically generate a random concurrencyExecutionId for this customer.

                          '
              customersWithContext:
                deprecated: true
                type: array
                description: "**Deprecated:** Instead use `customers` with array of objects. List of customers with context data. Each object must contain a `customerId` (alphanumeric string) and a `contextValues` object with key-value pairs representing dynamic context fields.\n\n**Only one of `customers` or `customersWithContext` should be provided per request.**\nExample:\n```json [\n  {\n    \"customerId\": \"be5d3f02f48647e2bd985128e1c4b065\",\n    \"contextValues\": {\n      \"offerBank\": \"300.00\",\n      \"subscriptionLevel\": \"premium\"\n    }\n  },\n  {\n    \"customerId\": \"be5d78f2f48647e2bd985128e1c4b066\",\n    \"contextValues\": {\n      \"offerBank\": \"220.00\",\n      \"subscriptionLevel\": \"basic\"\n    }\n  }\n] ```\n"
                items:
                  type: object
                  required:
                  - customerId
                  - contextValues
                  properties:
                    customerId:
                      type: string
                    contextValues:
                      type: object
  schemas:
    CS_OKSchema:
      required:
      - statusCode
      - message
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
    CS_ErrorStatusFormat:
      type: object
      properties:
        message:
          type: string
          description: Human readable error string
          example: must be integer
        path:
          type: string
          description: 'In the object, the field that is producing the error. JSON Pointer format (with / instead of points .)

            '
          example: /params/forward
        keyword:
          type: string
          description: "Type of validation that produced an error. For example: format, limit, pattern, type, etc. More information and schema errors in https://ajv.js.org/api.html#error-parameters\n\nThere are errors that are internal and do not belong to the schema validation and therefore are not found in the ajv documentation. Some of these errors are:\n  * `elseBranch`: In FLOW_FILTER when no else branch is declared\n  * `badWeightSum`: In FLOW_RANDOM, when all declared weights do not add to 1\n  * `campaignNotFound`: In ACTION_PUSH_SEND when campaign not found. The campaign must belong to the same application as the journey.\n  * `campaignNotValid`: In ACTION_PUSH_SEND when campaign has triggers. Only campaigns configured as inmediate send can be used in the journey.\n"
          example: type
        params:
          type: object
          description: 'Is defined by keyword value. Object with additional information about error.


            More information and examples: https://ajv.js.org/api.html#error-parameters

            '
    CS_ErrorJourneyCheckSchema:
      allOf:
      - $ref: '#/components/schemas/CS_ErrorSchema'
      - type: object
        properties:
          errors:
            description: 'List of errors that occur when checking a journey.

              '
            required:
            - code
            type: array
            items:
              type: object
              properties:
                code:
                  type: string
                  enum:
                  - ONE_INITIAL_STATE
                  - ONE_FINAL_STATE
                  - BAD_FORMAT
                  - NO_CHILDREN
                  - INVALID_CHILD_NOEXISTS
                  - INVALID_CHILD_DEPTH
                  - INVALID_CHILD_FLOW_PUSH_CLICK
                  - INVALID_CHILD_FLOW_SMS
                  - INVALID_CHILD_FLOW_CHAT
                  - NOT_CONNECTED
                  description: 'Human readable error string

                    * `ONE_INITIAL_STATE` - One and only one initial state is required

                    * `ONE_FINAL_STATE` - One and only one final state is required

                    * `BAD_FORMAT` - State with bad format. See stateId

                    * `NO_CHILDREN` - State without children. See stateId

                    * `INVALID_CHILD_NOEXISTS` - State refers to a child that does not exist

                    * `INVALID_CHILD_DEPTH` - Child in incorrect depth level

                    * `INVALID_CHILD_FLOW_PUSH_CLICK` - FLOW_PUSH_CLICK states only can be after ACTION_PUSH_SEND state

                    * `INVALID_CHILD_FLOW_SMS` - FLOW_SMS states only can be after ACTION_SMS_SEND state

                    * `INVALID_CHILD_FLOW_CHAT` - FLOW_CHAT states only can be after ACTION_CHAT_SEND state

                    * `NOT_CONNECTED` - Not connected state

                    '
                  example: must be integer
                stateId:
                  type:
                  - number
                  - 'null'
                  description: 'State id. Some error codes may not have stateId

                    '
                  example: 25
                badFormat:
                  description: Bad status format (`code` = `BAD_FORMAT`)
                  type: array
                  items:
                    $ref: '#/components/schemas/CS_ErrorStatusFormat'
    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
  - es-shipment
  - es-attachment
  - es-statistics
  - es-webhook
  - es-tasks
- name: InApp Service
  tags:
  - inapp-configuration
  - inapp-campaign
  - inapp-schema
  - inapp-topic
  - inapp-multimedia
  - inapp-form
  - inapp-stats
  - inapp-audience
  - inapp-task
- name: SMS Service
  tags:
  - sms-campaign
  - sms-configuration
  - sms-contact
  - sms-send
  - sms-stats
  - sms-topic
  - sms-cost
  - sms-webhook
  - sms-private
- name: Wallet Service
  tags:
  - wallet-project
  - wallet-images
  - wallet-tasks
  - wallet-notifications
  - wallet-template
  - wallet-loyalty-pass
  - wallet-loyalty-template
  - wallet-offer-pass
  - wallet-offer-template
  - wallet-generic-pass
  - wallet-generic-template
- name: Stats Service
  tags:
  - stats-service-chat
  - stats-service-cs
  - stats-service-report
  - stats-service-wallet
  - stats-service-meta
- name: ChatGen service
  tags:
  - icc-chatgen-gateway-agent
  - icc-chatgen-gateway-api-tool
  - icc-chatgen-gateway-configured-custom-tool
  - icc-chatgen-gateway-conversation
  - icc-chatgen-gateway-custom-tool
  - icc-chatgen-gateway-document
  - icc-chatgen-gateway-file
  - icc-chatgen-gateway-instance-config
  - icc-chatgen-gateway-router-agent-tool
  - icc-chatgen-gateway-router-agent
- name: AI Assitant service
  tags:
  - ai-generator-campaign
- name: Meta Service
  tags:
  - meta-cloudapi
  - meta-configuration
  - meta-webhook
  - meta-business
  - meta-templates
  - meta-upload
- name: Push Live Service
  tags:
  - push-live-configuration
  - push-live-ios-class
  - push-live-activity
  - push-live-send
- name: Pathbot
  tags:
  - pathbot-agents
  - pathbot-applications
  - pathbot-documents
  - pathbot-flows
  - pathbot-tools
  - pathbot-nodes
  - pathbot-ingestion-sources
  - pathbot-evaluation
  - pathbot-skills
- name: Link Service
  tags:
  - link-short-domain
x-provenance:
  method: searched
  source: https://documentation.indigitall.com/reference
  harvested: '2026-10-21'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://documentation.indigitall.com/reference/addagentstogroup.md
  - https://documentation.indigitall.com/reference/addcontactstolistcsv.md
  - https://documentation.indigitall.com/reference/addcontactstolistjson.md
  - https://documentation.indigitall.com/reference/addjourneywaitqueue.md
  - https://documentation.indigitall.com/reference/addjourneywaitqueuecsv.md
  - https://documentation.indigitall.com/reference/addskilltoagent.md
  - https://documentation.indigitall.com/reference/agentauthenticate.md
  - https://documentation.indigitall.com/reference/assigncontactstotag.md
  - https://documentation.indigitall.com/reference/assigntagstocontact.md
  - https://documentation.indigitall.com/reference/cancelemailtask.md
  - https://documentation.indigitall.com/reference/cancelsending.md
  - https://documentation.indigitall.com/reference/check-1.md
  - https://documentation.indigitall.com/reference/clearmemory.md
  - https://documentation.indigitall.com/reference/clone.md
  - https://documentation.indigitall.com/reference/clonecampaign.md
  - https://documentation.indigitall.com/reference/cloudapideletemedia.md
  - https://documentation.indigitall.com/reference/cloudapigetmedia.md
  - https://documentation.indigitall.com/reference/cloudapionboarding.md
  - https://documentation.indigitall.com/reference/cloudapisendmarketingmessages.md
  - https://documentation.indigitall.com/reference/cloudapisendmessages.md


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