indigitall Es Audience API

Endpoints for manage email audiences

Operations 8

GET /email/audience Get audiences list #
POST /email/audience Create an Audience #
DELETE /email/audience/{id} Delete an audience #
GET /email/audience/{id} Get an audience #
PUT /email/audience/{id} Update audience #
GET /email/audience/{id}/contacts/ Get audience contacs #
PUT /email/audience/{id}/contacts/ Update the contacts list of an audience #
PUT /email/audience/{id}/contacts/csv Add contacts from a csv file to an audience #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/indigitall:indigitall-es-audience-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

indigitall-es-audience-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 2.0.0
  title: INDIGITALL Es Audience 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: es-audience
  x-displayName: Email - Audiences
  description: Endpoints for manage email audiences
paths:
  /email/audience:
    get:
      tags:
      - es-audience
      summary: Get audiences list
      description: Get audiences list by application
      x-eov-operation-handler: audienceController
      operationId: emailGetAudienceListByApplication
      x-gateway-endpoint: emailService
      x-gateway-check-permission:
        account-features:
        - EMAIL_ENABLED
      parameters:
      - name: applicationId
        in: query
        description: application id
        required: true
        schema:
          type: integer
          format: int64
      - name: page
        in: query
        description: list page
        schema:
          type: integer
          format: int64
          default: 0
      - name: pageSize
        in: query
        description: page size
        schema:
          type: integer
          format: int64
          default: 20
      - name: find
        in: query
        description: find elements by title
        schema:
          type: string
      - name: orderBy
        in: query
        description: "Order of the results:\n\n  * a-z - Order by title ascending. From A to Z.\n  * z-a - Order by title descending. From Z to A.\n  * 0-9 - Order by id ascending.\n  * 9-0 - Order by id descending.\n"
        schema:
          type: string
          enum:
          - a-z
          - z-a
          - 0-9
          - 9-0
          default: 9-0
      responses:
        '200':
          $ref: '#/components/responses/ES_AudienceListResponse'
        '400':
          $ref: '#/components/responses/ES_ParameterMissingOrInvalidResponse'
        '401':
          $ref: '#/components/responses/ES_ErrorAppKeyResponse'
        '403':
          $ref: '#/components/responses/ES_ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ES_AudienceNotFoundResponse'
        '500':
          $ref: '#/components/responses/ES_ServerErrorResponse'
    post:
      tags:
      - es-audience
      summary: Create an Audience
      description: Create a new Audience, to send a email campaign to a selected list of users ((you need add contacts previously)
      x-eov-operation-handler: audienceController
      operationId: emailPostAudience
      x-gateway-endpoint: emailService
      x-gateway-check-permission:
        account-features:
        - EMAIL_ENABLED
      requestBody:
        $ref: '#/components/requestBodies/ES_AudienceRequestBody'
      responses:
        '201':
          $ref: '#/components/responses/ES_CreatedResponse'
        '400':
          $ref: '#/components/responses/ES_ParameterMissingOrInvalidResponse'
        '401':
          $ref: '#/components/responses/ES_ErrorAppKeyResponse'
        '403':
          $ref: '#/components/responses/ES_ForbiddenErrorResponse'
        '409':
          $ref: '#/components/responses/ES_ForeingKeyConstrintErrorResponse'
        '500':
          $ref: '#/components/responses/ES_ServerErrorResponse'
      x-codegen-request-body-name: audience
  /email/audience/{id}:
    delete:
      tags:
      - es-audience
      summary: Delete an audience
      description: Delete an existent audience
      x-eov-operation-handler: audienceController
      operationId: emailDeleteAudience
      x-gateway-endpoint: emailService
      x-gateway-check-permission:
        account-features:
        - EMAIL_ENABLED
      parameters:
      - name: id
        in: path
        description: audience's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/ES_AudienceDeletedResponse'
        '400':
          $ref: '#/components/responses/ES_ParameterMissingOrInvalidResponse'
        '401':
          $ref: '#/components/responses/ES_ErrorAppKeyResponse'
        '403':
          $ref: '#/components/responses/ES_ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ES_AudienceNotFoundResponse'
        '500':
          $ref: '#/components/responses/ES_ServerErrorResponse'
    get:
      tags:
      - es-audience
      summary: Get an audience
      description: Get the information of an existent audience. No return the contacts of the audience, only the quantity of them.
      x-eov-operation-handler: audienceController
      operationId: emailGetAudience
      x-gateway-endpoint: emailService
      x-gateway-check-permission:
        account-features:
        - EMAIL_ENABLED
      parameters:
      - name: id
        in: path
        description: audience's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/ES_AudienceResponse'
        '400':
          $ref: '#/components/responses/ES_ParameterMissingOrInvalidResponse'
        '401':
          $ref: '#/components/responses/ES_ErrorAppKeyResponse'
        '403':
          $ref: '#/components/responses/ES_ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ES_AudienceNotFoundResponse'
        '500':
          $ref: '#/components/responses/ES_ServerErrorResponse'
    put:
      tags:
      - es-audience
      summary: Update audience
      description: Update the info of an audience. Cannot change the contacts list in this endpoint, only the title and the type
      x-eov-operation-handler: audienceController
      operationId: emailPutAudience
      x-gateway-endpoint: emailService
      x-gateway-check-permission:
        account-features:
        - EMAIL_ENABLED
      parameters:
      - name: id
        in: path
        description: audience's id
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        $ref: '#/components/requestBodies/ES_AudiencePutRequestBody'
      responses:
        '200':
          $ref: '#/components/responses/ES_AudienceResponse'
        '400':
          $ref: '#/components/responses/ES_ParameterMissingOrInvalidResponse'
        '401':
          $ref: '#/components/responses/ES_ErrorAppKeyResponse'
        '403':
          $ref: '#/components/responses/ES_ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ES_AudienceNotFoundResponse'
        '409':
          $ref: '#/components/responses/ES_ForeingKeyConstrintErrorResponse'
        '500':
          $ref: '#/components/responses/ES_ServerErrorResponse'
      x-codegen-request-body-name: audience
  /email/audience/{id}/contacts/:
    get:
      tags:
      - es-audience
      summary: Get audience contacs
      description: Get a list of contacts from an audience. This list always is paginated.
      x-eov-operation-handler: audienceController
      operationId: emailGetAudienceContacts
      x-gateway-endpoint: emailService
      x-gateway-check-permission:
        account-features:
        - EMAIL_ENABLED
      parameters:
      - name: id
        in: path
        description: audience's id
        required: true
        schema:
          type: integer
          format: int64
      - name: contactsLimit
        in: query
        description: contacts limit
        required: false
        schema:
          type: integer
          format: int64
          minimum: 1
          maximum: 250
      - name: contactsPage
        in: query
        description: contacts page
        required: false
        schema:
          type: integer
          format: int64
          minimum: 0
      responses:
        '200':
          $ref: '#/components/responses/ES_AudienceResponseWithContacts'
        '400':
          $ref: '#/components/responses/ES_ParameterMissingOrInvalidResponse'
        '401':
          $ref: '#/components/responses/ES_ErrorAppKeyResponse'
        '403':
          $ref: '#/components/responses/ES_ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ES_AudienceNotFoundResponse'
        '500':
          $ref: '#/components/responses/ES_ServerErrorResponse'
    put:
      tags:
      - es-audience
      summary: Update the contacts list of an audience
      description: Add or remove a contacts list of an audience. You need to indicate the operation type (add or remove). Not recommended add or remove more than 1.000 contacts at once.
      x-eov-operation-handler: audienceController
      operationId: emailPutAudienceContacts
      x-gateway-endpoint: emailService
      x-gateway-check-permission:
        account-features:
        - EMAIL_ENABLED
      parameters:
      - name: id
        in: path
        description: audience's id
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        $ref: '#/components/requestBodies/ES_AudienceContactsPutRequestBody'
      responses:
        '200':
          $ref: '#/components/responses/ES_AudienceResponse'
        '400':
          $ref: '#/components/responses/ES_ParameterMissingOrInvalidResponse'
        '401':
          $ref: '#/components/responses/ES_ErrorAppKeyResponse'
        '403':
          $ref: '#/components/responses/ES_ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ES_AudienceNotFoundResponse'
        '409':
          $ref: '#/components/responses/ES_ForeingKeyConstrintErrorResponse'
        '500':
          $ref: '#/components/responses/ES_ServerErrorResponse'
      x-codegen-request-body-name: audience
  /email/audience/{id}/contacts/csv:
    put:
      tags:
      - es-audience
      summary: Add contacts from a csv file to an audience
      description: 'Add contacts from a csv file to an audience. Only can add users.

        For removing users from an audience, there is other endpoint.


        Adding more than a million users at a time is not recommended.


        CSV format example:

        ~~~

        email

        john@email.com

        eric@email.com

        andrew@email.com

        ~~~


        CSV format example 2:

        ~~~

        externalCode

        john

        eric

        andrew

        ~~~'
      x-eov-operation-handler: audienceController
      operationId: emailPutAudienceContactsCsv
      x-gateway-endpoint: emailService
      x-gateway-check-permission:
        account-features:
        - EMAIL_ENABLED
      parameters:
      - name: id
        in: path
        description: audience's id
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - csv
              properties:
                csv:
                  description: 'CSV format example:

                    ~~~

                    email

                    john@email.com

                    eric@email.com

                    andrew@email.com

                    ~~~


                    CSV format example 2:

                    ~~~

                    externalCode

                    john

                    eric

                    andrew

                    ~~~

                    '
                  type: string
                  format: binary
      responses:
        '200':
          $ref: '#/components/responses/ES_AudienceResponse'
        '400':
          $ref: '#/components/responses/ES_ParameterMissingOrInvalidResponse'
        '401':
          $ref: '#/components/responses/ES_ErrorAppKeyResponse'
        '403':
          $ref: '#/components/responses/ES_ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ES_AudienceNotFoundResponse'
        '409':
          $ref: '#/components/responses/ES_ForeingKeyConstrintErrorResponse'
        '500':
          $ref: '#/components/responses/ES_ServerErrorResponse'
      x-codegen-request-body-name: audience
components:
  responses:
    ES_AudienceDeletedResponse:
      description: Audience deleted
      content:
        application/json:
          schema:
            required:
            - statusCode
            - message
            - data
            type: object
            properties:
              statusCode:
                type: integer
                description: Response code
                example: 200
              message:
                type: string
                description: Response message, usually OK
                example: OK
              data:
                $ref: '#/components/schemas/ES_AudienceSchemaCount'
    ES_AudienceResponseWithContacts:
      description: OK
      content:
        application/json:
          schema:
            required:
            - statusCode
            - message
            type: object
            properties:
              statusCode:
                type: integer
                description: Response code
                example: 200
              message:
                type: string
                description: Response message, usually OK
                example: OK
              data:
                $ref: '#/components/schemas/ES_AudienceSchemaContacts'
    ES_ForeingKeyConstrintErrorResponse:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_ErrorSchema'
          example:
            statusCode: 409
            errorCode: ES_FOREING_KEY_CONSTRINT_ERROR
            message: Conflict
    ES_ServerErrorResponse:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_ErrorSchema'
          example:
            statusCode: 500
            errorCode: ES_SERVER_ERROR
            message: Server error
    ES_ForbiddenErrorResponse:
      description: Access Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_ErrorSchema'
          example:
            statusCode: 403
            errorCode: ES_ACCESS_FORBIDDEN
            message: Access Forbidden
    ES_ErrorAppKeyResponse:
      description: App key is not valid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_ErrorAppKeySchema'
          example:
            statusCode: 401
            errorCode: ES_APP_KEY_IS_NOT_VALID
            message: App key is not valid
    ES_CreatedResponse:
      description: Created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_CreatedSchema'
          example:
            statusCode: 201
            message: Created
    ES_AudienceNotFoundResponse:
      description: Audience not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_ErrorSchema'
          example:
            statusCode: 404
            errorCode: ES_AUDIENCE_NOT_FOUND
            message: Audience not found
    ES_AudienceResponse:
      description: OK
      content:
        application/json:
          schema:
            required:
            - statusCode
            - message
            type: object
            properties:
              statusCode:
                type: integer
                description: Response code
                example: 200
              message:
                type: string
                description: Response message, usually OK
                example: OK
              data:
                $ref: '#/components/schemas/ES_AudienceSchemaCount'
    ES_ParameterMissingOrInvalidResponse:
      description: Parameter is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_ErrorSchema'
          example:
            statusCode: 400
            errorCode: ES_PARAMETER_MISSING_OR_INVALID
            message: Parameter is missing or invalid
    ES_AudienceListResponse:
      description: OK
      content:
        application/json:
          schema:
            required:
            - statusCode
            - message
            - data
            - count
            type: object
            properties:
              statusCode:
                type: integer
                description: Response code
                example: 200
              message:
                type: string
                description: Response message, usually OK
                example: OK
              data:
                type: array
                items:
                  $ref: '#/components/schemas/ES_AudienceSchema'
              count:
                type: integer
                description: Number of audiences
  schemas:
    ES_ErrorSchema:
      required:
      - message
      - statusCode
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        errorCode:
          type: string
          enum:
          - ES_ATTACHMENT_NOT_FOUND
          - ES_SHIPMENT_SCHEDULED
          - ES_SHIPMENT_HAVE_VARS
          - ES_CAMPAIGN_NOT_FOUND
          - ES_CAMPAIGN_NOT_MODIFIABLE
          - ES_CAMPAIGN_TEMPLATE_NOT_FOUND
          - ES_CAMPAIGN_SENT
          - ES_CAMPAIGN_MULTIMEDIA_NOT_FOUND
          - ES_CAMPAIGN_HTML_NOT_FOUND
          - ES_CAMPAIGN_BLOCK_NOT_FOUND
          - ES_CAMPAIGN_BLOCK_COLUMN_NOT_FOUND
          - ES_CAMPAIGN_BLOCK_COLUMN_TYPE_ERROR
          - ES_COLUMNS_IN_BLOCK_LIMIT
          - ES_CONFIGURATION_ALREADY_EXISTS
          - ES_CONFIGURATION_NOT_FOUND
          - ES_CONFIGURATION_ERROR_MAILJET
          - ES_CONFIGURATION_DOMAIN_NOT_FOUND
          - ES_CONFIGURATION_DOMAIN_IN_USE
          - ES_CONFIGURATION_DOMAIN_EMAIL_NOT_FOUND
          - ES_CONFIGURATION_DOMAIN_EMAIL_IN_USE
          - ES_CONTACT_NOT_FOUND
          - ES_CATEGORY_NOT_FOUND
          - ES_CATEGORY_IN_USE
          - ES_APPLICATION_NOT_FOUND
          - ES_FOOTER_NOT_FOUND
          - ES_FOOTER_TITLE_EXISTS
          - ES_FOOTER_IN_USE
          - ES_SHIPMENT_NOT_FOUND
          - ES_CONFLICT
          - ES_ACCESS_FORBIDDEN
          - ES_AUDIENCE_CJ_NOT_FOUND
          description: '* `ES_ATTACHMENT_NOT_FOUND` - Attachment not found

            * `ES_SHIPMENT_SCHEDULED` - Shipment has been scheduled

            * `ES_SHIPMENT_HAVE_VARS` - Sending variables is not allowed in massive mailing.

            * `ES_CAMPAIGN_NOT_FOUND` - Campaign not found

            * `ES_CAMPAIGN_NOT_MODIFIABLE` - Campaign cannot be updated as it belongs to an initialized journey

            * `ES_CAMPAIGN_TEMPLATE_NOT_FOUND` - Campaign template not found

            * `ES_CAMPAIGN_SENT` - Campaign has been send

            * `ES_CAMPAIGN_MULTIMEDIA_NOT_FOUND` - Campaign multimedia not found

            * `ES_CAMPAIGN_HTML_NOT_FOUND` - Campaign html not found

            * `ES_CAMPAIGN_BLOCK_NOT_FOUND` - Campaign block not found

            * `ES_CAMPAIGN_BLOCK_COLUMN_NOT_FOUND` - Campaign block column not found * `ES_CAMPAIGN_BLOCK_COLUMN_TYPE_ERROR` - The parameters of the block column are not correct for this type * `ES_COLUMNS_IN_BLOCK_LIMIT` - The column limit for this block has been exceeded

            * `ES_CONFIGURATION_ALREADY_EXISTS` - Configuration already exists for application * `ES_CONFIGURATION_NOT_FOUND` - Configuration not found * `ES_CONFIGURATION_ERROR_MAILJET` - Error Mailjet Api

            * `ES_CONFIGURATION_DOMAIN_NOT_FOUND` - Configuration domain not found

            * `ES_CONFIGURATION_DOMAIN_IN_USE` - Configuration domain in use

            * `ES_CONFIGURATION_DOMAIN_EMAIL_NOT_FOUND` - Configuration domain email not found

            * `ES_CONFIGURATION_DOMAIN_EMAIL_IN_USE` - Configuration domain email in use

            * `ES_CONTACT_NOT_FOUND` - Contact not found

            * `ES_CATEGORY_NOT_FOUND` - Category not found

            * `ES_CATEGORY_IN_USE` - Category in use

            * `ES_APPLICATION_NOT_FOUND` - Application not found

            * `ES_FOOTER_NOT_FOUND` - Footer not found

            * `ES_FOOTER_IN_USE` - Footer in use

            * `ES_FOOTER_TITLE_EXISTS` - Footer title exists

            * `ES_SHIPMENT_NOT_FOUND` - Shipment not found

            * `ES_CONFLICT` - Unique contraint error

            * `ES_ACCESS_FORBIDDEN` - Access forbidden for user

            * `ES_AUDIENCE_CJ_NOT_FOUND` - The referenced Customer Journey (CJ) audience/segment was not found

            '
        message:
          type: string
          description: Error message
    ES_AudienceRequestSchema:
      required:
      - applicationId
      - title
      - type
      type: object
      properties:
        applicationId:
          type: integer
          format: int64
          description: Identifier of the associated application.
          example: 67890
        title:
          type: string
          description: Title or name of the audience.
          example: Seasonal Campaign Audience
        type:
          type: string
          enum:
          - email
          - externalCode
          description: Type of audience (e.g., `email` or `externalCode`).
          example: externalCode
    ES_AudiencePutRequestSchema:
      type: object
      properties:
        title:
          type:
          - string
          - 'null'
          description: Title or name of the audience.
          example: Updated Audience Title
        type:
          type: string
          enum:
          - email
          - externalCode
          description: Type of audience (e.g., `email` or `externalCode`).
          example: email
    ES_AudienceSchemaContacts:
      additionalProperties: false
      required:
      - id
      - applicationId
      - type
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier for the audience.
          example: 12345
        applicationId:
          type: integer
          format: int64
          description: Identifier of the associated application.
          example: 67890
        title:
          type:
          - string
          - 'null'
          description: Title or name of the audience.
          example: VIP Customers
        type:
          type: string
          enum:
          - email
          - externalCode
          description: Type of audience (e.g., `email` or `externalCode`).
          example: externalCode
        data:
          type:
          - array
          - 'null'
          description: List of contacts associated with the audience. Can contain emails or external codes.
          items:
            type: string
            description: Contact value (email or external code).
            example: user@example.com
        totalContacts:
          type: integer
          description: Total number of contacts in this audience.
          example: 150
    ES_AudienceSchemaCount:
      additionalProperties: false
      required:
      - id
      - applicationId
      - type
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier for the audience.
          example: 12345
        applicationId:
          type: integer
          format: int64
          description: Identifier of the associated application.
          example: 67890
        title:
          type:
          - string
          - 'null'
          description: Title or name of the audience.
          example: Loyalty Program Participants
        type:
          type: string
          enum:
          - email
          - externalCode
          description: Type of audience (e.g., `email` or `externalCode`).
          example: email
        totalContacts:
          type: integer
          description: Total number of contacts in this audience.
          example: 2000
    ES_AudienceContactsPutRequestSchema:
      type: object
      properties:
        operation:
          type: string
          enum:
          - add
          - remove
          description: Operation to perform on the contact list (`add` or `remove`).
          example: add
        data:
          type: array
          description: List of contacts to add or remove. It is not recommended to include more than 1000 contacts.
          items:
            type: string
            description: Contact value (email or external code).
            example: customer123
    ES_ErrorAppKeySchema:
      required:
      - data
      - message
      - statusCode
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Error message
        data:
          type: object
          properties: {}
          description: Error data
    ES_AudienceSchema:
      additionalProperties: false
      required:
      - id
      - applicationId
      - type
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier for the audience.
          example: 12345
        applicationId:
          type: integer
          format: int64
          description: Identifier of the associated application.
          example: 67890
        title:
          type:
          - string
          - 'null'
          description: Title or name of the audience.
          example: Marketing Campaign Audience
        type:
          type: string
          enum:
          - email
          - externalCode
          description: Type of audience (e.g., `email` or `externalCode`).
          example: email
    ES_CreatedSchema:
      required:
      - statusCode
      - message
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually Created
  requestBodies:
    ES_AudienceContactsPutRequestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_AudienceContactsPutRequestSchema'
    ES_AudiencePutRequestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_AudiencePutRequestSchema'
    ES_AudienceRequestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_AudienceRequestSchema'
  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


# --- truncated at 32 KB (66 KB total) ---
# Full source: https://artifacts.apis.io/indigitall/openapi/indigitall-es-audience-api-openapi.yml