ACADEMY - My Learning DOCS & GUIDESAPIPARTNERS FAQ
Dev Guide
indigitall

indigitall API suite

API Reference
indigitall API suite

Build and scale multi-channel orchestration with the indigitall APIs.

At indigitall, we provide several APIs to help you seamlessly integrate our communication tools into your tech stack. Here is a quick breakdown of what is available and when to use it:

  • API v2 (Recommended): This is our current standard. Use v2 for managing your audience, creating campaigns, and interacting with the core platform. It is faster, more robust, and continually updated with new capabilities.
  • API v1 (Legacy): Our first-generation API. It is still supported to ensure backward compatibility for older integrations, but it is no longer receiving major feature updates.
  • Transactional Push API: Specifically built for speed and reliability. Use this API when you need to fire off one-to-one transactional messages instantly, such as password resets, delivery confirmations, or security alerts.
⚠️ Recommendation. For all new development, always default to API v2. By relying on our latest API, you ensure your integration is future-proof, secure, and fully equipped with indigitall's latest features.
Filter:
INDIGITALL API — Unified Messaging, Contact Center, CDP & AI (v2 services, current)

Chat

35

Channel Templates

3
POSTCreate channel template DELDelete channel template POSTUpload file to channel

Contacts

7
GETGet contacts POSTBulk create contacts PUTBulk update contacts POSTBulk create contacts from CSV GETGet contact by ID GETDownload contact report GETGet contact messages

Send Messages

4
POSTSend campaign to all contacts POSTSend messages to all contacts POSTSend messages to contact list POSTSend campaign messages to contact list

Tags

11
POSTCreate a new tag GETList all tags GETGet a tag by ID PUTUpdate a tag DELDelete a tag POSTAssign contacts to a tag DELUnassign contacts from a tag GETGet contacts assigned to a tag POSTAssign tags to a contact DELUnassign tags from a contact GETGet tags assigned to a contact

Contact Lists

10
POSTCreate a new contact list GETList all contact lists GETGet a contact list by ID PUTUpdate a contact list DELDelete a contact list GETList contacts from a contact list POSTAdd contacts to a contact list (JSON) DELRemove contacts from a contact list (JSON) POSTBulk add contacts from CSV to contact list DELBulk remove contacts from CSV from contact list

Contact Center

53

Agents

7
POSTCreate a new agent GETGet agents GETGet agent by ID PUTUpdate agent DELDelete agent POSTAuthenticate agent GETGet agent connection history

Permissions Profiles

5
POSTCreate a new permissions profile GETGet permissions profiles GETGet permissions profile by ID PUTUpdate permissions profile DELDelete permissions profile

Weekly & Special-Day Schedules

10
POSTCreate a new weekly schedule GETGet weekly schedules GETGet weekly schedule by ID PUTUpdate weekly schedule DELDelete weekly schedule POSTCreate a new special days schedule GETGet special days schedules GETGet special days schedule by ID PUTUpdate special days schedule DELDelete special days schedule

Conversations

3
GETGet contact center conversations GETGet unread messages count for conversations POSTRegister contact center conversation form response

Agent Groups

8
POSTCreate a new agent group GETList all agent groups GETGet an agent group by ID PUTUpdate an agent group DELDelete an agent group POSTAdd agents to a group DELRemove agents from a group GETList agents in a group

Contact Comments

4
POSTCreate a new contact comment GETList all comments for a contact PUTUpdate a contact comment DELDelete a contact comment

Forms & Form Questions

10
GETGet contact center form POSTCreate contact center form PUTUpdate contact center form DELDelete contact center form POSTCreate contact center form question PUTUpdate contact center form question DELDelete contact center form question POSTCreate contact center form question option PUTUpdate contact center form question option DELDelete contact center form question option

Contact Center Stats

3
GETGet KPIs for contact center GETGet contact summary GETDownload messages history report

Internal / Security

3
GETGet Contact Center pods status and configuration DELDelete agents PUTManually unblock conversations blocked by the security Analyzer

CDP & Customer Journey

28

Customer Events & Fields

3
GETGet stored customer events PUTEdits customer field POSTCompute aggregated field values

Journey Control & Wait Queue

5
PUTPut a list of audiences to a journey that is already running POSTAdd customers to the journey's wait queue (JSON) POSTAdd customers to the journey's wait queue (CSV) GETGet the count of customers in the wait queue DELRemove customers from the journey's wait queue

Segments & Audiences

9
GETRetrieves customers for a segment GETDownload customers CSV for a segment POSTCreates an audience GETGet all audience list GETGets one audience list by id DELDelete one audience list by id PUTUpdate one audience list by id GETRetrieves customers for an audience list GETDownload customers CSV for an audience list

Applications & Tasks

3
GETGet all audiences and segments available for an application GETGet a single audience or segment available for an application GETGet all tasks

CDP Event Types

8
POSTCreates a CDP Event Type GETGet all CDP Event Types GETGets one CDP Event Type by id DELDelete one CDP Event Type by id PUTUpdate one CDP Event Type by id (name must be unique) POSTCompute all aggregated fields of event type POSTCreates a CDP Event Type from a template GETGet all CDP Event Type Templates

Channels & Ops

21

Email Tasks

4
PUTDismiss task notification PUTCancel task GETGet task GETGet tasks list

SMS & RCS Configuration

6
POSTCreates new SMS/RCS configuration GETGet the configuration of an application PUTUpdates a configuration DELDeletes a configuration PUTUnblock configuration POSTShow number of reached devices for campaign

Journey Stats

2
GETDownload statistics as a CSV file for a given application's ID and date range GETGet journey date statistics for user entry

Meta / WhatsApp Marketing

5
POSTSend a marketing message via Meta MM Lite API POSTCreate a message template DELDelete a message template POSTStart an upload session POSTStart the upload

Short Link Domains

4
POSTCreate custom short domain GETGet custom short domain PUTUpdate custom short domain DELRemove custom short domain

Pathbot AI Agent Builder

25

Documents

6
POSTUpload multiple files to a document POSTBulk create documents from a CSV DELBulk delete documents from a CSV GETGet document chunks PUTUpdate a document entity GETDownload all documents as a zip file

Ingestion Sources

6
POSTCreate a new ingestion source GETGet all ingestion sources GETGet an ingestion source PUTUpdate an ingestion source DELDelete an ingestion source POSTIngest an ingestion source

Flows & Tools

2
DELClear flow memory GETRetrieve all operations for a tool

Evaluation

3
POSTUpload an evaluation file for agent flow testing POSTRerun an evaluation GETGet evaluation statistics

Skills

8
POSTCreate a new skill GETRetrieve all skills GETRetrieve a skill by ID PUTUpdate a skill by ID DELDelete a skill by ID POSTAdd a skill to an agent DELRemove a skill from an agent GETRetrieve skills for an agent
Device Server API & Push Secure Sending API

Device Server API — Customer

4

Customer

4
GETGet customer information PUTAssigns or updates values to customer fields DELDeletes values from customer fields POSTCreate an event in customer service

Push Secure Sending API

7

Notifications

4
POSTSecurely send a notification POSTSecurely send a notification to one device GETGets statuses from a notification GETGets notification feed

Campaigns & Status

3
POSTSecurely send a campaign POSTSecurely send a campaign to one device GETGets the Server status
INDIGITALL API v1 — Console (api.indigitall.com/v1)

Auth, Users & Accounts

21

Status & Auth

4
GETGets the Server status POSTAuthorize a user and returns a TOKEN POSTAuthorize an user wich 2FA is enabled and returns a TOKEN GETRefresh short lived JWT and TOTP code

Users

6
POSTCreate a New User GETList of Users for an account data GETShow User for the given id PUTUpdate user with the given id DELDelete a user with the given id POSTAdd image to user profile

Roles, Recovery & Security

8
POSTSet specific permission to user with given id DELDelete specific permission from user with given id POSTSends invitation email to the given email POSTSends email to the user with reset procedure GETShow list of roles assignable to users POSTRegisters a new user POSTChanges user password GETUnblocks user

Accounts

3
GETShow account with features GETShow accounts list with her features GETShow account logs

Applications & Setup

73

Applications

5
POSTCreate Application GETShow Applications List GETShow Application With the Given ID PUTUpdate Application With the Given ID DELDelete Application With the Given ID

External Apps & Auth

8
GETShow External Apps List for the Given Application's ID POSTCreate External Apps List for the Given Application ID PUTUpdate External Apps for the Given Application's ID DELDelete External Apps for the Given Application ID GETGet External Auth Data for External Login POSTCreate External Auth PUTEdit External Auth Config DELDelete External Auth

Topics

8
POSTCreate Topics for the Given Application's ID GETShow Topics for the Given Application's ID PUTUpdate Topics for the Given Application's ID DELDelete Topics for the Given Application ID DELDelete Device Topic Association GETObtain List With Devices Codes POSTObtain List With Devices Codes DELDelete Device Topic Association

Topic Devices (CSV)

3
POSTCreate Device for Topic With CSV for the Given Application's ID GETDownload a CSV File With Device Codes and External IDs DELDelete Topic Devices From CSV

Areas & Geofences

8
POSTCreate Areas for the Given Application's ID GETShow Areas for the Given Application's ID PUTUpdate Areas for the Given Application's ID DELDelete Areas for the Given Application ID POSTAdd Areas From CSV for the Given Application's ID GETShow Areas for the Given Application's ID in CSV File DELDelete Areas From CSV for the Given Application's ID GETShow Areas for the Given Application's ID (by Tag)

Categories

4
POSTCreate a New Category to Application GETShow Categories List for a Given Application's ID PUTUpdate Category With the Given Application's ID DELDelete a Category With the Given Application's ID

Web Analytics & Assets

6
POSTAdd Image for the Given Application's ID POSTAdd Certificate Files for the Given Application's ID POSTCreate Web Analytic Parameters GETShow Google Analytics List for a Given Campaign's ID PUTUpdate Web Analytic With the Given Application's ID DELDelete a Web Analytic With the Given Web Analytic's ID

Chat Toggle & Cloud API / MM Lite

5
GETStatus and Configuration of a Chat Service Associated With an Application PUTSet the Configuration of a Chat Service Associated With an Application GETGet the Onboarding Status of MM Lite POSTInitiate MM Lite Onboarding POSTSynchronize MM Lite Status

Heatmaps & Word Clouds

7
GETPush Success Heatmap by Weekday and Hour POSTPush Success Heatmap by Weekday and Hour POSTOmnichannel Success Heatmap by Weekday and Hour GETWord Success Values in Push Notifications GETWord Success Values Across Any or All Channels GETDevices per Segment for a Segmentation Type POSTDevice Count Heatmap by Viewport Grid Area

Application Statistics

8
GETGet a List of Dates That Have Files With Statistics GETObtain File With One Day's Statistics GETShow General Statistics for the Given Application's ID GETShow Statistics for the Given Application's ID Between Two Dates GETShow Statistics for the Given Application's ID Between Two Dates in a CSV File GETReturns Statistical Data of the Applications Belonging to an Account GETGeneral Statistics From Chat Service GETShow Statistics From Chat Service

Push Stats by Device

4
GETShow Statistics for Push by Devices GETDownload CSV With Statistics for Push by Devices GETShow Devices With Push Errors GETDownload CSV File With Devices Push Errors

Device Status & Bulk Management

7
GETObtain Token to Download the CSV File With Device Status GETReturn the Precalculated Device Status CSV File POSTReturn the Status of Devices List POSTReturn the Information of Devices List GETReturns a List of Devices by External IDs PUTEdit a Set of Devices in Bulk by External IDs or Device IDs PUTEdit a Set of Devices in Bulk by External IDs or Device IDs (CSV)

Campaigns & Testing

40

Campaigns

11
POSTCreate a campaign in application GETShow campaign list for a given application's id GETShow campaign with the given campaign's id PUTUpdate campaign with the given campaign's id DELDelete a campaign with the given campaign's id POSTAdd a picture to the given campaign's id POSTUpload a video to be used in a campaign POSTAdd an icon to the given campaign's id POSTGives a score for the campaign depending on the text in its title POSTExtract meta tags from a given URL POSTCheck if any of the campaign urls have been previously sent

Send & Targeting

8
POSTSend the selected campaign POSTSend the selected campaign targeting all devices that match the filters POSTSend the selected campaign targeting the specified devices POSTSet a list of target devices for campaign POSTSend the selected campaign to a specific list of devices (CSV) GETShow campaign sendings GETList of scheduled sendings POSTShow number of reached devices for campaign

Campaign Stats

5
GETGets the application's sendings stats GETGets the application's sendings stats in .csv format GETShow the statistics for the given campaign's id between two dates GETReturns the statistics associated with a campaign GETReturns the information associated with a specific campaign's stats

A/B Testing

7
POSTCreate a new A/B test GETList A/B tests for a given application's ID GETShow A/B test with the given test's ID PUTUpdate A/B test with the given test's ID DELDelete A/B test with the given test's ID POSTCreate A/B test to be sent GETShow A/B test stats with the given test's ID

Multi Testing

9
POSTAdd a new multi-test GETShow the multi-test and test list POSTCheck for multi-test POSTPrepare and send multi-test POSTCancel the multi-test's send PUTUpdate the status of the multi-test GETShow the status of the multi-test DELDelete the multi-test GETShow multi-testing stats with the given test's ID

Integrations & Extras

28

CRM Integrations

13
POSTCreate a new Salesforce user PUTUpdate a Salesforce integration GETShow Salesforce integration for the given ID POSTCreate a new Salesforce Service Cloud integration GETDownload Salesforce Service Cloud certificate PUTUpdate a Salesforce Service Cloud integration GETShow Salesforce Service Cloud integration for the given ID POSTCreate a new HubSpot user PUTUpdate a HubSpot integration GETShow HubSpot integration for the given account ID POSTCreate a new Cloud District user PUTUpdate a Cloud District integration GETShow Cloud District integration for the given user ID

WordPress, Zapier & Directory

6
GETList of integrations POSTCreate a new WordPress user GETShow WordPress integrations POSTCreate a new Zapier integration GETShow integration user for the given Zapier integration ID DELDelete an integration user with the given ID

Inbox, Recommendations & Diagnostics

9
GETGet inbox configuration for an application PUTUpdate inbox configuration for an application GETGet the most recommended feature for an application POSTDismiss a feature recommendation for an application GETCheck the validity of a URL GETGet sending stats by ID PUTCancel a sending by ID GETReturns the count of devices sent in a given date range GETGet stats for the application dashboard

Updated 17 days ago

Did this page help you?

Updated 17 days ago

Did this page help you?