indigitall Send API

openapi: 3.2.0
info:
  version: 1.0.0
  title: INDIGITALL API v1 Send API
  x-gateway-endpoint: accountService
  description: '### Introduction

    This documentation describes the interface of Indigitall''s API version 1.

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

    ### Authentication

    Every request to this 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}

    ```


    ### Support

    For further information or if you need support you can contact with support@indigitall.com'
servers:
- url: https://api.indigitall.com/v1
security:
- Authorization: []
tags:
- name: Send
paths:
  /send/{id}/cancel:
    parameters:
    - in: path
      name: id
      description: Send's id
      required: true
      schema:
        type: integer
    put:
      summary: Put the sending state to Cancelled
      description: Change the property 'cancelled' to true by false or false by true of the selected sending
      x-gateway-endpoint: pushService
      operationId: updatedSendIdCancel
      tags:
      - Send
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendPutResponse'
        '400':
          description: Parameters missing or not in right format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Operation forbidden for your user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Application not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /send/{id}/stats:
    parameters:
    - in: path
      name: id
      description: Send's id
      required: true
      schema:
        type: integer
    get:
      summary: Gets the sending stats by id
      deprecated: true
      description: '**THIS METHOD IS DEPRECATED, PLEASE USE/campaignstats/{id} INSTEAD. IT WILL BE REMOVED IN THE FUTURE.**


        Gets the stats for the selected sendign.


        Returns the features and statistical data such as the number of devices

        to what was sent and the amount they clicked on it'
      x-gateway-endpoint: pushService
      x-gateway-path: /v1/stats/send
      x-gateway-controller: sendController
      operationId: getSendIdStats
      tags:
      - Send
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendStatsResponse'
        '400':
          description: Parameters missing or not in right format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Operation forbidden for your user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Application not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      required:
      - statusCode
      - message
      properties:
        statusCode:
          type: integer
          description: Response code
        errorCode:
          type: string
          enum:
          - AUTH_ERROR
          - TOO_MANY_REQUESTS
          - IP_WHITELIST
          - PS_INTERNAL_ERROR
          - PS_FORBIDDEN
          - PS_BAD_REQUEST
          - PS_ARGUMENTS
          - PS_DATE_FORMAT
          - PS_DATE_RANGE
          - PS_DATE_RANGE_MAX
          - PS_INVALID_TOPIC_CODE
          - PS_TOPIC_NOT_FOUND
          - PS_APPLICATION_NOT_FOUND
          - PS_CAMPAIGN_NOT_FOUND
          - PS_TEST_NOT_FOUND
          - PS_MULTITEST_NOT_FOUND
          - PS_SENDING_NOT_FOUND
          - PS_SENDING_ALREADY_CANCELLED
          - PS_CSV_EMPTY
          - PS_CSV_FIELD_NOT_FOUND
          - PS_CSV_SIZE
          - PS_BAD_CSV_FORMAT
          - PS_CAMPAIGN_TIMEZONE
          - PS_CAMPAIGN_ACTION
          - PS_CAMPAIGN_BUTTON
          - PS_CAMPAIGN_TRIGGER
          - PS_CAMPAIGN_OVERWRITE_PROPERTIES
          - PS_CAMPAIGN_BAD_VIDEO
          - PS_CAMPAIGN_BAD_VIDEO_TYPE
          - PS_CAMPAIGN_BAD_VIDEO_SIZE
          - PS_CAMPAIGN_BAD_VIDEO_SIZE_AFTER_CONVERSION
          - PS_CAMPAIGN_BAD_ICON_TYPE
          - PS_CAMPAIGN_BAD_ICON_SIZE
          - PS_CAMPAIGN_TARGETS
          - PS_FEATURE_GEOFENCING_DISABLED
          - PS_FEATURE_NETWORK_DISABLED
          - PS_MULTITEST_INVALID
          - PS_MULTITEST_ALREADY_SENT
          - PS_BAD_IMAGE_TYPE
          - PS_BAD_IMAGE_SIZE
          - PS_CAMPAIGN_CUSTOMER_SERVICE
          - PS_CAMPAIGN_CUSTOMER_SERVICE_SENDING
          - PS_CAMPAIGN_INVALID_CATEGORY_ID
          - PS_EXTRACT_META_PARSE_HTML_ERROR
          - PS_AUDIENCE_CJ_NOT_FOUND
          - AS_INTERNAL_ERROR
          - AS_FORBIDDEN
          - AS_BAD_REQUEST
          - AS_LIMIT_EXCEEDED
          - AS_INVALID_CREDENTIALS
          - AS_ELEMENT_NOT_FOUND
          - AS_LOCKED_INACTIVITY
          - AS_LOCKED_EXPIRED_PASSWORD
          - AS_LOCKED_TOO_MANY_LOGIN_ATTEMPTS
          - AS_APPLICATION_NOT_FOUND
          - AS_ACCOUNT_NOT_FOUND
          - AS_EXTERNAL_APP_NOT_FOUND
          - AS_AREA_NOT_FOUND
          - AS_WEB_ANALYTIC_NOT_FOUND
          - AS_CATEGORY_NOT_FOUND
          - AS_EXTERNAL_AUTH_NOT_FOUND
          - AS_USER_NOT_FOUND
          - AS_INTEGRATION_NOT_FOUND
          - AS_PERMISSION_NOT_FOUND
          - AS_ROLE_NOT_FOUND
          - AS_IP_WHITELIST
          - AS_CHAT_FEATURE_DISABLED
          - AS_CONTACT_CENTER_FEATURE_DISABLED
          - AS_RESOURCE_ALREADY_EXISTS
          - AS_EMAIL_ALREADY_EXISTS
          - AS_TOPIC_ALREADY_EXISTS
          - AS_CATEGORY_ALREADY_EXISTS
          - AS_USER_ALREADY_EXISTS
          - AS_SAFARI_ID_ALREADY_EXISTS
          - AS_EXTERNAL_AUTH_DATA_ALREADY_EXISTS
          - AS_TOPIC_PARENT_NOT_FOUND
          - AS_INVALID_CERTIFICATE
          - AS_BAD_SAFARI_CONFIGURATION
          - AS_BAD_HARMONY_CONFIGURATION
          - AS_BAD_ANDROID_CONFIGURATION
          - AS_BAD_REPORTING_CONFIGURATION
          - AS_BAD_SLICING_CONFIGURATION
          - AS_BAD_APP_CODE
          - AS_BAD_TOPIC_CODE
          - AS_BAD_IMAGE_TYPE
          - AS_BAD_IMAGE_SIZE
          - AS_BAD_CSV_FORMAT
          - AS_BAD_EMAIL
          - AS_PASSWORD_MANDATORY
          - AS_PASSWORD_TOO_SHORT
          - AS_PASSWORD_COMPLEXITY_NOT_MET
          - AS_PASSWORD_PERSONAL_INFO
          - AS_PASSWORD_REUSED
          - AS_PASSWORD_MISMATCH
          - AS_PASSWORD_SAME_OLD
          - AS_PASSWORD_TOO_MANY_CHANGES
          - PS_TEST_INVALID
          - PS_TEST_ALREADY_SENT
          - AS_ONLY_SUPER_ADMIN_PERMISSION
          - AS_INVALID_METHOD
          - AS_INVALID_TOTP
          - AS_INVALID_TOKEN
          - AS_CHAT_DOWNLOAD_ACCOUNTS_FEATURE_DISABLED
          - AS_CHAT_V2_FEATURE_DISABLED
          - AS_CHAT_V2_PERMISSION_PROFILE_NOT_FOUND
          - AS_CHAT_V2_UPSTREAM_ERROR
          - CS_CSV_NUMBER_OF_PARAMS
          - CS_CSV_EMPTY_FILE
          - CS_CSV_INVALID_CHANNEL
          - CS_CSV_INVALID_CONTENT_TYPE
          - CS_CSV_INVALID_PARAMETER
          - CS_CSV_INVALID_TYPE
          - CS_CSV_MISSING_FIELDS
          - CS_CSV_EMPTY_FIELDS
          - CS_DOWNLOAD_MULTIMEDIA_ERROR
          description: "Sort order:\n  * `AUTH_ERROR` - Authorization error\n  * `TOO_MANY_REQUESTS` - TOO_MANY_REQUESTS\n  * `IP_WHITELIST` - The ip with which you are trying to access the resource is not allowed\n  * `PS_INTERNAL_ERROR` - Internal Server Error\n  * `PS_FORBIDDEN` - Forbidden action\n  * `PS_BAD_REQUEST` - Generic bad request\n  * `PS_ARGUMENTS` - Error in any of the arguments\n  * `PS_DATE_FORMAT` - The specified date format is not correct\n  * `PS_DATE_RANGE` - It indicated a range of dates not allowed\n  * `PS_DATE_RANGE_MAX` - Indicates that the range between two dates exceeds the maximum limit\n  * `PS_INVALID_TOPIC_CODE` - The topic code has a wrong format\n  * `PS_TOPIC_NOT_FOUND` - The topic code has a wrong format\n  * `PS_APPLICATION_NOT_FOUND` - Application / project not found\n  * `PS_CAMPAIGN_NOT_FOUND` - Campaign not found\n  * `PS_CAMPAIGN_NOT_MODIFIABLE` - Campaign cannot be updated as it belongs to an initialized journey\n  * `PS_TEST_NOT_FOUND` - Test not found\n  * `PS_MULTITEST_NOT_FOUND` - Multitest not found\n  * `PS_SENDING_NOT_FOUND` - Sending not found\n  * `PS_SENDING_ALREADY_CANCELLED` - Sending already cancelled or has a past date scheduled\n  * `PS_CSV_EMPTY` - The CSV has a wrong format: it is empty\n  * `PS_CSV_FIELD_NOT_FOUND` - The CSV has a wrong format: a required field is missing\n  * `PS_CSV_SIZE` - The CSV has an impermissible size\n  * `PS_BAD_CSV_FORMAT` - Generic CSV format error\n  * `PS_CAMPAIGN_TIMEZONE` - The property Timezone camapaña has an incorrect value\n  * `PS_CAMPAIGN_ACTION` - There was an error trying to process the actions of the campaign\n  * `PS_CAMPAIGN_BUTTON` - There was an error trying to process the campaign buttons\n  * `PS_CAMPAIGN_TRIGGER` - There was an error trying to process the triggers of the campaign\n  * `PS_CAMPAIGN_OVERWRITE_PROPERTIES` - There was an error trying to process the properties overwrite campaign\n  * `PS_CAMPAIGN_BAD_VIDEO` - There was an error trying to process the video of the campaign\n  * `PS_CAMPAIGN_BAD_VIDEO_TYPE` - There was an error trying to process the video of the campaign. Video type is not allowed.\n  * `PS_CAMPAIGN_BAD_VIDEO_SIZE` - There was an error trying to process the video of the campaign. The size of the video exceeds the maximum allowable size.\n  * `PS_CAMPAIGN_BAD_VIDEO_SIZE_AFTER_CONVERSION` - There was an error trying to process the video of the campaign. The size of the video then convert it exceeds the maximum allowable size.\n  * `PS_CAMPAIGN_BAD_ICON_TYPE` - There was an error trying to process the icon of the campaign. The type of icon is invalid.\n  * `PS_CAMPAIGN_BAD_ICON_SIZE` - There was an error trying to process the icon of the campaign. The size of the icon is invalid.\n  * `PS_CAMPAIGN_TARGETS` - There was an error trying to process the targets of the campaign\n  * `PS_FEATURE_GEOFENCING_DISABLED` - The feature 'gefencing' is disabled for this account\n  * `PS_FEATURE_NETWORK_DISABLED` - The feature 'network' is disabled for this account\n  * `PS_MULTITEST_INVALID` - The test contains invalid data\n  * `PS_MULTITEST_ALREADY_SENT` - The multitest has already been sent\n  * `PS_BAD_IMAGE_TYPE` - Image has invalid format\n  * `PS_BAD_IMAGE_SIZE` - Image has invalid size\n  * `PS_TEST_INVALID` - This test is not valid on this endpoint or has invalid configuration\n  * `PS_TEST_ALREADY_SENT` - The test has already been sent\n  * `PS_CAMPAIGN_CUSTOMER_SERVICE` - Campaigns with the onlyCustomerService field set to true cannot use triggers or filtering other than platform\n  * `PS_CAMPAIGN_CUSTOMER_SERVICE_SENDING` - Campaigns with the onlyCustomerService field set to true can only be sent from a journey.\n                                            Customer service can only send campaigns with this field set to true.\n  * `PS_CAMPAIGN_INVALID_CATEGORY_ID` - The category id indicated in a campaign is invalid, does not exist or belongs to another application\n  * `PS_EXTRACT_META_PARSE_HTML_ERROR` - Error during meta tag extraction due to HTML parsing failure\n  * `PS_AUDIENCE_CJ_NOT_FOUND` - The CJ audience or segment indicated in the audienceCJ filter was not found in customer-service\n  * `AS_INTERNAL_ERROR` - Generic internal error\n  * `AS_FORBIDDEN` - Generic forbidden error\n  * `AS_BAD_REQUEST` - Generic bad request\n  * `AS_LIMIT_EXCEEDED` - Some of the configured limits have been exceeded\n  * `AS_INVALID_CREDENTIALS` - Invalid credentials\n  * `AS_ELEMENT_NOT_FOUND` - Element not found\n  * `AS_LOCKED_INACTIVITY` - User is locked for inactivity. Please, contact an administrator\n  * `AS_LOCKED_EXPIRED_PASSWORD` - The password is way old. Please, change it for a new one\n  * `AS_LOCKED_TOO_MANY_LOGIN_ATTEMPTS` - Too many login attempts\n  * `AS_APPLICATION_NOT_FOUND` - Application (project) not found\n  * `AS_ACCOUNT_NOT_FOUND` - Account not found\n  * `AS_EXTERNAL_APP_NOT_FOUND` -\n  * `AS_AREA_NOT_FOUND` -\n  * `AS_WEB_ANALYTIC_NOT_FOUND` -\n  * `AS_CATEGORY_NOT_FOUND` -\n  * `AS_EXTERNAL_AUTH_NOT_FOUND` -\n  * `AS_USER_NOT_FOUND` -\n  * `AS_INTEGRATION_NOT_FOUND` -\n  * `AS_PERMISSION_NOT_FOUND` -\n  * `AS_ROLE_NOT_FOUND` -\n  * `AS_IP_WHITELIST`- The ip with which you are trying to access the resource is not allowed\n  * `AS_CHAT_FEATURE_DISABLED` - Chat Service is not activated for this account\n  * `AS_CONTACT_CENTER_FEATURE_DISABLED` - Contact Center is not activated for this account\n  * `AS_RESOURCE_ALREADY_EXISTS` - Generic error when trying to duplicate a resource\n  * `AS_EMAIL_ALREADY_EXISTS` - User with same email already exists\n  * `AS_TOPIC_ALREADY_EXISTS` - Topic code already exists in this application\n  * `AS_CATEGORY_ALREADY_EXISTS` - Category code already exists in this application\n  * `AS_USER_ALREADY_EXISTS` - User already exists\n  * `AS_SAFARI_ID_ALREADY_EXISTS` - Safari push ID already exists\n  * `AS_EXTERNAL_AUTH_DATA_ALREADY_EXISTS` - External auth already exists\n  * `AS_TOPIC_PARENT_NOT_FOUND` - Topic parent not found\n  * `AS_INVALID_CERTIFICATE` - Invalid certificate credentials or invalid certificate\n  * `AS_BAD_SAFARI_CONFIGURATION` - It has been requested to activate Safari push, however, the necessary parameters for this service has not been provided.\n  * `AS_BAD_HARMONY_CONFIGURATION` - It has been requested to activate Harmony push, however, the necessary parameters for this service has not been provided.\n  * `AS_BAD_ANDROID_CONFIGURATION` - It has been requested to activate Android push, however, the necessary parameters for this service has not been provided.\n  * `AS_BAD_REPORTING_CONFIGURATION` - Reporting configuration object does not have the expected format\n  * `AS_BAD_SLICING_CONFIGURATION` - Slicing configuration object does not have the expected format\n  * `AS_BAD_APP_CODE` - App code does not have the expected format\n  * `AS_BAD_TOPIC_CODE` - Topic code does not have the expected format\n  * `AS_BAD_IMAGE_TYPE` - Image format is different than expected\n  * `AS_BAD_IMAGE_SIZE` - Image file size exceeds maximum size\n  * `AS_BAD_CSV_FORMAT` - The format of the CSV file is not as expected. It may be empty or may not contain the expected columns or headers.\n  * `AS_BAD_EMAIL` - Email was not found or is in the wrong format\n  * `AS_PASSWORD_MANDATORY` - Password field is mandatory and cannot be empty\n  * `AS_PASSWORD_TOO_SHORT` - Password is too short\n  * `AS_PASSWORD_COMPLEXITY_NOT_MET` - Password must include at least three of the following categories: numbers, lowercase letters, uppercase letters, or special characters\n  * `AS_PASSWORD_PERSONAL_INFO` - Password must not contain personal information (name, email, etc.)\n  * `AS_PASSWORD_REUSED` - Password has been used before\n  * `AS_PASSWORD_MISMATCH` - currentPassword does not match with user current password\n  * `AS_PASSWORD_SAME_OLD` - Old and new password shoud be different\n  * `AS_PASSWORD_TOO_MANY_CHANGES` - Password has been changed too many times in a short period of time\n  * `AS_ONLY_SUPER_ADMIN_PERMISSION` - Only super administrator has permission to perform this action\n  * `AS_INVALID_METHOD` - The totp method is not valid\n  * `AS_INVALID_TOTP` - The totp code is not valid\n  * `AS_INVALID_TOKEN` - The JWT user is not the same that body user.\n  * `AS_CHAT_DOWNLOAD_ACCOUNTS_FEATURE_DISABLED` - download contacts is not active in this account.\n  * `CS_CSV_NUMBER_OF_PARAMS` - Number of incorrect parameters\n  * `CS_CSV_EMPTY_FILE` - Empty file or no data\n  * `CS_CSV_INVALID_CHANNEL` - Only Whatsapp channel is allowed\n  * `CS_CSV_INVALID_CONTENT_TYPE` - Invalid contentType. Only `template` contentType is available\n  * `CS_CSV_INVALID_PARAMETER` - Invalid parameter\n  * `CS_CSV_INVALID_TYPE` - Invalid file type\n  * `CS_CSV_MISSING_FIELDS` - Missings fields\n  * `CS_CSV_EMPTY_FIELDS` - Empty fields\n  * `CS_DOWNLOAD_MULTIMEDIA_ERROR` - Error in download file by URL\n  * `AS_CHAT_V2_FEATURE_DISABLED` - Chat V2 is not active in this account.\n  * `AS_CHAT_V2_PERMISSION_PROFILE_NOT_FOUND` - The permission profile specified in the request was not found.\n  * `AS_CHAT_V2_UPSTREAM_ERROR` - An error occurred while processing the request in the upstream service.\n"
        message:
          type: string
          description: Error message
    PushButtonObject:
      type: object
      description: Push button
      required:
      - label
      - action
      properties:
        label:
          type: string
          description: Button's label
        action:
          $ref: '#/components/schemas/ActionObject'
    PlatformSendArray:
      type: object
      required:
      - platformGroup
      - numDevicesSent
      - numDevicesSuccess
      - numDevicesReceived
      - numDevicesClicked
      properties:
        platformGroup:
          type: string
          description: Platform group. The possible platforms are Android, iOS, webpush, Safari and Harmony
        numDevicesSent:
          type: integer
          description: Number of impacts sent
        numDevicesSuccess:
          type: integer
          description: Number of impacts succeeded (i.e. the push provider returned OK)
        numDevicesReceived:
          type: integer
          description: Number of impacts received
        numDevicesClicked:
          type: integer
          description: Number of impacts clicked
        numDevicesClickedButtons:
          type: object
          description: Number of impacts clicked by button
    PushObject:
      type: object
      description: Campaign's properties
      required:
      - title
      - body
      - action
      properties:
        title:
          type: string
          description: Push title
        body:
          type: string
          description: Push body
        icon:
          type: string
          description: Url of push icon in android
        image:
          type: string
          description: Url of push image
        gif:
          type: string
          description: Url of push gif
        video:
          type: string
          description: Url of push video. If a null or empty value is specified during editing, the existing video will be deleted
        videoThumbTimeKey:
          type: integer
          description: Time key (in seconds) used to extract the thumbnail. This field is mandatory when video field is set and must be the same value returned in the endpoint /campaign/video
        data:
          type: string
          description: other data
        layout:
          type: string
          enum:
          - basic
          - half_width
          - full_width
          description: layout
        timezone:
          type: string
          description: Valid timezone (default value is UTC)
        action:
          $ref: '#/components/schemas/ActionObject'
        requireInteraction:
          type: boolean
          description: If push must require user interaction or not(webpush)
        buttons:
          type: array
          description: Array of push buttons
          items:
            $ref: '#/components/schemas/PushButtonObject'
    SendStatsResponse:
      required:
      - statusCode
      - message
      - data
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        data:
          type: object
          required:
          - properties
          - stats
          properties:
            properties:
              type: object
              description: Object of Properties Push
              properties:
                features:
                  $ref: '#/components/schemas/PushObject'
            stats:
              type: array
              description: Array of Platform Sending
              items:
                $ref: '#/components/schemas/PlatformSendArray'
    ActionObject:
      type: object
      description: Device action
      required:
      - type
      properties:
        topics:
          type: array
          description: If topics exist in action, suscribe to the specified
          items:
            type: string
            description: Topic code
        destroy:
          type: boolean
          description: If push is going to be deleted from the screen
        type:
          type: string
          enum:
          - app
          - url
          - call
          - market
          - share
          - no_action
          - webview
          - wallet
          description: "Action's type\n\n  - app: Deeplinking\n  - url: Open url\n  - call: Call to phone number\n  - market: Open apps market\n  - share: Share content\n  - no_action: No action\n  - webview: Web view\n  - wallet: Download\n"
        app:
          type: string
          description: If action's type is app, indicates the deeplink
        url:
          type: string
          description: If action's type is url, indicates the url to open
        call:
          type: string
          description: If action's type is call, indicates the phone number to call
        market:
          type: string
          description: If action's type is market, indicates the package to open in market
        share:
          type: string
          description: If action's type is share, indicates the content to share
        wallet:
          type: string
          description: If action's type is wallet, URL to download the wallet file (pkpass)
        webview:
          type: string
          description: If action's type is webview, indicates the webview to open
    SendPutResponse:
      required:
      - statusCode
      - message
      - data
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        data:
          type: object
          properties:
            cancelled:
              type: boolean
              description: sending state cancelled
  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}**

        '
    AuthorizationQueryString:
      type: apiKey
      in: query
      name: key
      description: "Authorization for accesing endpoints , must be in one of the following format:\n\n  - ?key={token}\n"
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/addusertogroup.md
  - https://documentation.indigitall.com/reference/assignstickyagent.md
  - https://documentation.indigitall.com/reference/blockconversation.md
  - https://documentation.indigitall.com/reference/check.md
  - https://documentation.indigitall.com/reference/checkmultitest.md
  - https://documentation.indigitall.com/reference/checkurl.md
  - https://documentation.indigitall.com/reference/cloudapihealth.md
  - https://documentation.indigitall.com/reference/cloudapiregister.md
  - https://documentation.indigitall.com/reference/configure360.md
  - https://documentation.indigitall.com/reference/createagentgroup.md
  - https://documentation.indigitall.com/reference/createcannedmessage.md
  - https://documentation.indigitall.com/reference/createform.md
  - https://documentation.indigitall.com/reference/createformquestion.md
  - https://documentation.indigitall.com/reference/createformquestionoption.md
  - https://documentation.indigitall.com/reference/createtopic.md
  - https://documentation.indigitall.com/reference/deleteagentgroup.md
  - https://documentation.indigitall.com/reference/deleteapplication.md
  - https://documentation.indigitall.com/reference/deleteapplicationareas.md
  - https://documentation.indigitall.com/reference/deleteapplicationareascsv.md
  - https://documentation.indigitall.com/reference/deleteapplicationcategory.md
  - https://documentation.indigitall.com/reference/deleteapplicationexternalapps.md
  - https://documentation.indigitall.com/reference/deleteapplicationtopicdevicescsv.md
  - https://documentation.indigitall.com/reference/deleteapplicationtopicdeviceslist.md
  - https://documentation.indigitall.com/reference/deleteapplicationtopics.md
  - https://documentation.indigitall.com/reference/deleteapplicationwebanalytic.md
  - https://documentation.indigitall.com/reference/deletecampaign.md
  - https://documentation.indigitall.com/reference/deletecannedmessage.md
  - https://documentation.indigitall.com/reference/deletechannel.md
  - https://documentation.indigitall.com/reference/deleteconversationtag.md
  - https://documentation.indigitall.com/reference/deletedevicetopic.md
  - https://documentation.indigitall.com/reference/deleteexternalauth.md
  - https://documentation.indigitall.com/reference/deleteform.md
  - https://documentation.indigitall.com/reference/deleteformquestion.md
  - https://documentation.indigitall.com/reference/deleteformquestionoption.md
  - https://documentation.indigitall.com/reference/deleteintegrateduser.md
  - https://documentation.indigitall.com/reference/deleteintegration.md
  - https://documentation.indigitall.com/reference/deletemultimedia.md
  - https://documentation.indigitall.com/reference/deletemultitest.md
  - https://documentation.indigitall.com/reference/deleteplugin.md
  - https://documentation.indigitall.com/reference/deletetest.md
  - https://documentation.indigitall.com/reference/deletetopic.md
  - https://documentation.indigitall.com/reference/deleteuser.md
  - https://documentation.indigitall.com/reference/deleteuserpermission.md
  - https://documentation.indigitall.com/reference/deletewabaflow.md
  - https://documentation.indigitall.com/reference/deletewabatemplate.md
  - https://documentation.indigitall.com/reference/deletewaprofilephoto.md
  - https://documentation.indigitall.com/reference/deletewebhook.md
  - https://documentation.indigitall.com/reference/downloadmultimedia.md
  - https://documentation.indigitall.com/reference/downloadmultimediabyidorcode.md
  - https://documentation.indigitall.com/reference/editcontactattributes.md
  - https://documentation.indigitall.com/reference/editconversationtag.md
  - https://documentation.indigitall.com/reference/editdevicesbulk.md
  - https://documentation.indigitall.com/reference/editdevicesbulkcsv.md
  - https://documentation.indigitall.com/reference/editplugin.md
  - https://documentation.indigitall.com/reference/generate360token.md
  - https://documentation.indigitall.com/reference/get2farefresh.md
  - https://documentation.indigitall.com/reference/getaccountlogs.md
  - https://documentation.indigitall.com/reference/getaccountpublic.md
  - https://documentation.indigitall.com/reference/getaccounts.md
  - https://documentation.indigitall.com/reference/getagentconversations.md
  - https://documentation.indigitall.com/reference/getagentdatestats.md
  - https://documentation.indigitall.com/reference/getagentsessionsmessagescsv.md
  - https://documentation.indigitall.com/reference/getagentsstatus.md
  - https://documentation.indigitall.com/reference/getallagentgroups.md
  - https://documentation.indigitall.com/reference/getallblocked.md
  - https://documentation.indigitall.com/reference/getallcannedmessages.md
  - https://documentation.indigitall.com/reference/getallgroupsforoneagent.md
  - https://documentation.indigitall.com/reference/getapplication.md
  - https://documentation.indigitall.com/reference/getapplicationareas.md
  - https://documentation.indigitall.com/reference/getapplicationareascsv.md
  - https://documentation.indigitall.com/reference/getapplicationcategory.md
  - https://documentation.indigitall.com/reference/getapplicationdatestats.md
  - https://documentation.indigitall.com/reference/getapplicationdatestatscsv.md
  - https://documentation.indigitall.com/reference/getapplicationexternalapps.md
  - https://documentation.indigitall.com/reference/getapplicationstats.md
  - https://documentation.indigitall.com/reference/getapplicationstatsbyaccount.md
  - https://documentation.indigitall.com/reference/getapplicationstatsbydevices.md
  - https://documentation.indigitall.com/reference/getapplicationstatsbydevicescsv.md
  - https://documentation.indigitall.com/reference/getapplicationstatsdashboard.md
  - https://documentation.indigitall.com/reference/getapplicationtopicdevicescsv.md
  - https://documentation.indigitall.com/reference/getapplicationtopicdeviceslist.md
  - https://documentation.indigitall.com/reference/getapplicationtopics.md
  - https://documentation.indigitall.com/reference/getapplicationwebanalytic.md
  - https://documentation.indigitall.com/reference/getareatag.md
  - https://documentation.indigitall.com/reference/getcampaign.md
  - https://documentation.indigitall.com/reference/getcampaigndatestats.md
  - https://documentation.indigitall.com/reference/getcampaignsend.md
  - https://documentation.indigitall.com/reference/getcampaignstats.md
  - https://documentation.indigitall.com/reference/getcampaignstatsbyid.md
  - https://documentation.indigitall.com/reference/getcampaignstatscsv.md
  - https://documentation.indigitall.com/reference/getcampaignstatsentitybyid.md
  - https://documentation.indigitall.com/reference/getchannellist.md
  - https://documentation.indigitall.com/reference/getchat.md
  - https://documentation.indigitall.com/reference/getchatconfiguration.md
  - https://documentation.indigitall.com/reference/getchatdatestats.md
  - https://documentation.indigitall.com/reference/getchatsendingmessagescsv.md
  - https://documentation.indigitall.com/reference/getchatstats.md
  - https://documentation.indigitall.com/reference/getchattoken.md
  - https://documentation.indigitall.com/reference/getclouddistrictuser.md
  - https://documentation.indigitall.com/reference/getcontactid.md
  - https://documentation.indigitall.com/reference/getcontacts.md
  - https://documentation.indigitall.com/reference/getcontactscsv.md
  - https://documentation.indigitall.com/reference/getconversationtaglist.md
  - https://documentation.indigitall.com/reference/getcsv.md
  - https://documentation.indigitall.com/reference/getdevicesbyexternalcode.md
  - https://documentation.indigitall.com/reference/getdevicestatusprecalccsv.md
  - https://documentation.indigitall.com/reference/getdevicestatusprecalccsvdownload.md
  - https://documentation.indigitall.com/reference/getdeviceswithpusherror.md
  - https://documentation.indigitall.com/reference/getdeviceswithpusherrorcsv.md


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