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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/indigitall:indigitall-pushsend-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
openapi: 3.2.0
info:
version: 1.0.0
title: INDIGITALL API v1 Push 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: pushSend
x-displayName: Push Send
description: Endpoints for send
paths:
/campaign/{id}/send:
post:
deprecated: true
summary: Send the selected campaign
description: '**THIS METHOD IS DEPRECATED, PLEASE USE /send/all OR /send/list ENDPOINTS**
___
Prepare the campaign to be sent instantly or when it is decided. Through the body you can schedule the delivery date (**scheduleAt**), send a specific list of devices (**deviceList**) or a group of devices that share the same external code (**externalIds**) and program it according to an event, passing the id of that event (**triggerId**).
If the campaign is of type custom, through the property **deviceCustomList** or **externalCustomList** you can send the data for each device.
The **deviceList**, **deviceCustomList** and **externalCustomList** fields have preference over the data added through a csv with the endpoint /campaign/{id}/targets'
operationId: postCampaignSend
x-gateway-mode: custom
x-gateway-controller: notificationController
tags:
- pushSend
parameters:
- in: path
name: id
required: true
description: Campaign's id
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignSendRequest'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SendCampaignResponse'
'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: Campaign not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/campaign/{id}/send/all:
post:
summary: Send the selected campaign targeting all devices that match the filters
description: 'Prepares the campaign to be sent to all devices that match the campaign''s filters.
It can be sent immediatly or scheduled for a date.'
x-gateway-endpoint: pushService
operationId: postCampaignSendAll
tags:
- pushSend
parameters:
- in: path
name: id
required: true
description: Campaign's id
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignSendAllRequest'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SendCampaignResponse'
'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: Campaign not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/campaign/{id}/send/list:
post:
summary: Send the selected campaign targeting the specified devices
description: 'Prepares the campaign to be sent to specified devices applying campaign''s filters.
The devices in the list can be refered by its deviceId or externalId, this can be set with idType parameter, which is deviceId by default.
---
* Example with deviceId
```
{
"idType": "deviceId",
"deviceList" : [
{
"id" : "deviceId1"
},
{
"id": "deviceId2"
}
]
}
```
* Example with externalId
```
{
"idType": "externalId",
"deviceList" : [
{
"id" : "externalId1"
},
{
"id": "externalId2"
}
]
}
```
---
If the campaign contains customizable fields, those can be included in the list.
* Example with customizable fields. Keep in mind that campaign must cointains these fields, in this example, {{myfield1}} and {{myfield2}}
```
{
"idType": "deviceId",
"deviceList" : [
{
"id" : "deviceId1"
"customFields":
{
"myfield1" : "fieldvalue"
"myfield2" : "fieldvalue"
}
},
{
"id": "deviceId2"
"customFields":
{
"myfield1" : "fieldvalue"
"myfield2" : "fieldvalue"
}
}
]
}
```'
x-gateway-endpoint: pushService
operationId: postCampaignSendList
tags:
- pushSend
parameters:
- in: path
name: id
required: true
description: Campaign's id
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignSendListRequest'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SendCampaignResponse'
'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: Campaign 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
ContentStateObject:
type: object
description: object with attributes to send live activity push
SendCampaignResponse:
required:
- statusCode
- message
- data
properties:
statusCode:
type: integer
description: Response code
message:
type: string
description: Error message
data:
type: object
properties:
sendingId:
type: integer
description: Sending's Id
CampaignSendListRequest:
type: object
required:
- deviceList
example:
idType: deviceId
deviceList:
- id: deviceId1
- id: deviceId2
properties:
scheduleAt:
type: string
description: "Schedule the push to this time. The date format is ISO-8601.\nIf a scheduled date already exists, the oldest one not sent will be canceled.\nThe date must be greater than the current date\n\n Ex:\n\n 2019-02-13T08:18:39.632Z\n"
triggerId:
type: integer
x-hidden: true
description: Add trigger reference to the sending.
idType:
type: string
enum:
- deviceId
- externalId
default: deviceId
description: Set de the id type for the deviceList. It can be deviceId or externalId
deviceList:
type: array
minimum: 1
description: 'Array of devices that will be target of the sending.
It can includes customizable fields if needed in customFields property.
'
items:
type: object
required:
- id
properties:
id:
type: string
description: device reference, can be deviceId or externalId, depending on the idType property value.
customFields:
type: object
description: Object with campaing's customizable fields, must be one key per field and its value.
contentIosAvailable:
type: integer
description: 'Set the contentAvailable parameter for iOS pushes
'
enum:
- 0
- 1
smartTime:
type: string
description: 'Activate the smart send functionality and set the day the send should be made.
The date must have an ISO-8601 format of the type YYYY-MM-DD.
If this property is set, it is mandatory to also specify the smartTimezone property.
'
smartTimezone:
type: string
description: 'Indicates the time zone that we must use to interpret the date indicated in the smartTime field.
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Example: Europe/Madrid
'
contentState:
description: Object with attributes to send live activity push
$ref: '#/components/schemas/ContentStateObject'
CampaignSendAllRequest:
type: object
properties:
scheduleAt:
type: string
description: "Schedule the push to this time. The date format is ISO-8601.\nIf a scheduled date already exists, the oldest one will not be sent, it will be canceled.\nThe date must be greater than the current date\n\n Ex:\n\n 2019-02-13T08:18:39.632Z\n"
triggerId:
type: integer
x-hidden: true
description: Add trigger reference to the sending
smartTime:
type: string
description: 'Activate the smart send functionality and set the day the send should be made.
The date must have an ISO-8601 format of the type YYYY-MM-DD.
If this property is set, it is mandatory to also specify the smartTimezone property.
'
smartTimezone:
type: string
description: 'Indicates the time zone that we must use to interpret the date indicated in the smartTime field.
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Example: Europe/Madrid
'
contentIosAvailable:
type: integer
description: 'Set the contentAvailable parameter for iOS pushes
'
enum:
- 0
- 1
contentState:
$ref: '#/components/schemas/ContentStateObject'
CampaignSendRequest:
type: object
properties:
scheduleAt:
type: string
description: "Schedule the push to this time. The date format is ISO-8601.\nIf a scheduled date already exists, the oldest one not sent will be canceled.\nThe date must be greater than the current date\n\n Ex:\n\n 2019-02-13T08:18:39.632Z\n"
triggerId:
type: integer
x-hidden: true
description: Add trigger to the sending, whose id corresponds to the one entered.
deviceList:
type: array
description: "Array of device codes. If exists, the campaign will send to these devices\nExample:\n\n [ \"12654qew-qweqe-123swe\", \"asad4q4e65a-asqwe4785-asd45-qewer12\",...,\"asd1351das-sdfssdfs-415ds4-we48\" ]\n"
items:
type: string
deviceCustomList:
type: array
description: "Array of device codes with custom fields. If it exists, the campaign will be sent to these devices. Each object that is part of the array must contain the deviceId of the device and the same number of properties as of values to replace. Each property with the name of the field to be replaced and the value to be entered.\ndeviceId must be unique.\nExample:\n\n [\n { \"deviceId\":\"12654qew-qweqe-123swe\", \"data1\": 12312, \"data2\": \"pweo323o\",...,\"datan\":\"asdas\" },\n ...\n ]\n"
items:
type: object
externalIds:
type: array
description: "Array of external codes, similar a tags for devices. Useful if you want to send to several devices of the same user identified by this code\nExample:\n\n [\"prueba1\", \"test1\", ..., \"n\"]\n"
items:
type: string
externalCustomList:
type: array
description: "Array of external codes with custom fields, similar a tags for devices. Useful if you want to send to several devices of the same user identified by this code\nEach object that is part of the array must contain the externalId and the same number of properties as of values to replace.\nEach property with the name of the field to be replaced and the value to be entered.\nexternalId must be unique.\nExample:\n\n [\n { \"externalId\":\"12654qew-qweqe-123swe\", \"data1\": 12312, \"data2\": \"pweo323o\",...,\"datan\":\"asdas\" },\n ...\n ]\n"
items:
type: object
smartTime:
type: string
description: 'Activate the smart send functionality and set the day the send should be made.
The date must have an ISO-8601 format of the type YYYY-MM-DD.
If this property is set, it is mandatory to also specify the smartTimezone property.
'
smartTimezone:
type: string
description: 'Indicates the time zone that we must use to interpret the date indicated in the smartTime field.
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Example: Europe/Madrid
'
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
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://artifacts.apis.io/indigitall/openapi/indigitall-pushsend-api-openapi.yml