indigitall Account API

openapi: 3.2.0
info:
  version: 1.0.0
  title: INDIGITALL API v1 Account 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: Account
  x-displayName: Account
  description: Endpoints for managing account
paths:
  /account:
    get:
      summary: Show accounts list with her features
      description: Obtain information of the accounts. Also get the features of it.
      operationId: getAccounts
      tags:
      - Account
      parameters:
      - in: query
        name: find
        description: filter by account's name
        schema:
          type: string
      - in: query
        name: enabled
        description: filter by actived accounts
        schema:
          type: boolean
      - in: query
        name: limit
        required: true
        description: 'results per page. max: 100'
        schema:
          type: integer
          maximum: 100
          default: 10
      - in: query
        name: page
        required: true
        description: 'page of results. min: 0'
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountListGetResponse'
        '400':
          description: Parameters missing or not in right format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Account not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /account/{id}:
    parameters:
    - in: path
      name: id
      required: true
      description: Account's id
      schema:
        type: integer
    get:
      summary: Show account with features
      description: Obtain information about the selected account. Also get the features of it.
      operationId: getAccountPublic
      x-gateway-mode: custom
      x-gateway-controller: accountController
      tags:
      - Account
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPublicGetResponse'
        '400':
          description: Parameters missing or not in right format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Account not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /account/{id}/logs:
    parameters:
    - in: path
      name: id
      required: true
      description: filter by account's Id
      schema:
        type: integer
    get:
      summary: Show accounts list with her features
      description: Obtain information of the accounts. Also get the features of it.
      operationId: getAccountLogs
      tags:
      - Account
      parameters:
      - in: query
        name: find
        description: filter by action, email or serverKey
        schema:
          type: string
      - in: query
        name: userId
        description: filter by user's Id
        schema:
          type: integer
      - in: query
        name: limit
        required: true
        description: 'results per page. max: 100'
        schema:
          type: integer
          maximum: 100
          default: 10
      - in: query
        name: page
        required: true
        description: 'page of results. min: 0'
        schema:
          type: integer
          default: 0
      - in: query
        name: userType
        description: Filter by user type
        schema:
          type: string
          enum:
          - human
          - server
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountLogsListResponse'
        '400':
          description: Parameters missing or not in right format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Account not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    FeaturesObject:
      required:
      - locationUpdateMinutes
      - deviceAppLimit
      - deviceWebLimit
      - deviceTotalLimit
      - accountLimit
      - applicationLimit
      - geoFencingEnabled
      - reportingEnabled
      - statsDownloadEnabled
      - appPushEnabled
      - webPushEnabled
      - apiUseEnabled
      properties:
        locationUpdateMinutes:
          type: integer
          description: Account's mimimum value for location refresh minutes
        deviceAppLimit:
          type: integer
          description: Account's device limit from apps
        deviceWebLimit:
          type: integer
          description: Account's device limit from web
        deviceTotalLimit:
          type: integer
          description: Account's device limit in total
        accountLimit:
          type: integer
          description: Account's users limit
        applicationLimit:
          type: integer
          description: Account's applications limit
        geoFencingEnabled:
          type: boolean
          description: if account has enabled geofencing feature
        reportingEnabled:
          type: boolean
          description: if account has enabled reporting feature
        statsDownloadEnabled:
          type: boolean
          description: if account has enabled stats download feature
        appPushEnabled:
          type: boolean
          description: if account has enabled app push feature
        webPushEnabled:
          type: boolean
          description: if account has enabled web push feature
        apiUseEnabled:
          type: boolean
          description: if account has enabled API use feature
        inAppEnabled:
          type: boolean
          description: if account has enabled inApp
        inWebEnabled:
          type: boolean
          description: if account has enabled inWeb
        massiveSendEnabled:
          type: boolean
          description: if account can realize massive sends (without filters)
          default: true
        chatEnabled:
          type: boolean
          description: if account can use chat-service
        chatCallCenterEnabled:
          type: boolean
          description: if account can use chat call center mode
        chatCallCenterMaxAgents:
          type: integer
          description: Account call center max agents
        devicesPartition:
          type: boolean
          description: if devices data for this account must have its own partition
        iosVideoEnabled:
          type: boolean
          description: if account can use video in ios platform
        inboxEnabled:
          type: boolean
          description: If account has active inbox
        networkEnabled:
          type: boolean
          description: If an account has active network filter and automatism
        smartTimeEnabled:
          type: boolean
          description: Indicates if smart send at the best time is on
        secureSendingEnabled:
          type: boolean
          description: If an account has active secure pushes delivery
        customerEnabled:
          type: boolean
          description: If an account has customer enabled
        walletEnabled:
          type: boolean
          description: If an account has wallet enabled
        massiveChatEnabled:
          type: boolean
          description: If account can use massive chat sends
        emailEnabled:
          type: boolean
          description: If account can use email services
        columnTopicCsvEnabled:
          type: boolean
          description: If account cant add Topic column to campaign statistics
        inappV2Enabled:
          type: boolean
          description: If account can use new inapp v2 service
        smsEnabled:
          type: boolean
          description: If account can use sms service
        smsDownloadStatistics:
          type: boolean
          description: If account can download statictics of sms
        inappV2DownloadStatistics:
          type: boolean
          description: If account can download statictics of inappV2
        chatDownloadContacts:
          type: boolean
          description: If account can download csv contacts in chat service
        walletDeviceWebLimit:
          type: integer
          description: Account's device limit from Wallet Webpush
        generatorCallsPerDay:
          type: integer
          description: Maximum number of calls per day to the campaign generator
        chatAdminChatgen:
          type: boolean
          description: If account can admin chat gen
        pushSecureApiRateLimit:
          type: integer
          description: Account's push secure api rate limit
        smsCanOverrideSendType:
          type: boolean
          description: Allows forcing a change in SMS send type
        metaEnabled:
          type: boolean
          description: If account can use meta service like Passthrough. It is not necessary to activate it if the account has the chat service enabled
        pushLiveEnabled:
          type: boolean
          description: If account can use push live service
        chatPartition:
          type: boolean
          description: If chat data for this account must have its own partition
        massiveSmsSendEnabled:
          type: boolean
          description: If account can use massive SMS sends
        chatV2Enabled:
          type: boolean
          description: If account can use chat v2 service
        customerDataCsvExportEnabled:
          type: boolean
          description: If customer data CSV export feature is enabled
        pathbotEnabled:
          type: boolean
          description: If account can use pathbot service
        smsIgnoreCsvErrors:
          type: boolean
          description: If account can ignore errors in CSV files when sending SMS
        massiveEmailSendEnabled:
          type: boolean
          description: If account can use massive Email sends
        cjCdpEventsIngestionEnabled:
          type: boolean
          description: If account can ingest Cdp Events (customer-service)
        cjCdpFieldAggregatedEnabled:
          type: boolean
          description: If account can process aggregated fields (customer-service)
        cjCdpFieldMaxRetentionDays:
          type: integer
          description: Maximum number of days to retain events and fields in our CDP
        cjCdpFieldMaxCompFields:
          type: integer
          description: Maximum number of computed fields (simple or aggregated) allowed for this account
        cjCdpEventsMaxDailyIngestion:
          type: integer
          description: Maximum number of Cdp Events that can be ingested daily for this account
        inappV2AudienceAllowDeviceId:
          type: boolean
          description: If account can allow using device id in audiences for inapp v2
        dataTalkEnabled:
          type: boolean
          description: If account can use datatalk service
          default: false
        advancedAnalyticsEnabled:
          type: boolean
          description: If account can use advanced analytics
    AccountListGetResponse:
      required:
      - statusCode
      - message
      - data
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        data:
          type: array
          description: Array of the accounts
          items:
            $ref: '#/components/schemas/AccountObject'
        count:
          type: integer
          description: Counter total registers
    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
    logsObject:
      type: object
      description: data logs
      properties:
        id:
          type: integer
          description: test's id
        accountId:
          type: integer
          description: account's id
        applicationId:
          description: application's id
          type:
          - integer
          - 'null'
        applicationName:
          description: application's name
          type:
          - string
          - 'null'
        userId:
          type: integer
          description: user's id
        userImage:
          description: user's image
          type:
          - string
          - 'null'
        email:
          description: user's email
          type:
          - string
          - 'null'
        serverKey:
          description: user's serverKey
          type:
          - string
          - 'null'
        userName:
          description: user's name
          type:
          - string
          - 'null'
        resourceName:
          description: resource's name
          type:
          - string
          - 'null'
        action:
          type: string
          description: log's action
        description:
          type: object
          description: the specifict data of the action
        createdAt:
          type: string
          description: "test's creation time. The format is ISO 8601, UTC-0\n\n  Ex:\n\n    2019-02-13T08:18:39.632Z\n"
    AccountRatesObjectV2:
      required:
      - deviceAppLimit
      - deviceWebLimit
      - deviceTotalLimit
      - accountLimit
      - applicationLimit
      properties:
        deviceAppLimit:
          type: integer
          description: How many devices from apps are enabled for the account
        deviceWebLimit:
          type: integer
          description: How many devices from web are enabled for the account
        deviceTotalLimit:
          type: integer
          description: How many devices in total are enabled for the account
        accountLimit:
          type: integer
          description: How many accounts are created for the account
        applicationLimit:
          type: integer
          description: How many applications are created for the account
    AccountPublicGetResponse:
      required:
      - statusCode
      - message
      - data
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        data:
          type: object
          allOf:
          - $ref: '#/components/schemas/AccountObject'
          - type: object
            required:
            - features
            - rates
            properties:
              features:
                $ref: '#/components/schemas/FeaturesObject'
              rates:
                $ref: '#/components/schemas/AccountRatesObjectV2'
    AccountLogsListResponse:
      required:
      - statusCode
      - message
      - data
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        data:
          type: array
          description: data logs
          items:
            $ref: '#/components/schemas/logsObject'
    AccountObject:
      required:
      - id
      - name
      - enabled
      properties:
        id:
          type: integer
          description: Account's id
        createdAt:
          type: string
          description: "Account's creation date. The format is ISO 8601, UTC-0\n\n  Ex:\n\n    2019-02-13T08:18:39.632Z\n"
        updatedAt:
          type: string
          description: "Account's last update date. The format is ISO 8601, UTC-0\n\n  Ex:\n\n    2019-02-13T08:18:39.632Z\n"
        name:
          type: string
          description: Account's name
        enabled:
          type: boolean
          description: If account is enabled
        accountType:
          type:
          - string
          - 'null'
          description: Account's type
          enum:
          - ENTERPRISE
          - null
        allowedCommunications:
          type: boolean
          description: Acceptance of commercial communications
  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


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