Send messages to all contacts

post

https://api.indigitall.com/v2/chat/{applicationId}/send/all

Send one or more messages to all contacts in the application.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationId

integer

required

Application's ID

Body Params

sendType

string

enum

Defaults to proactive

Use a proactive sendType when you want to send a message campaign to users without them having sent a message beforehand.
A campaign with proactive sendType can be sent through all sending endpoints and integrations.

Use a reactive sendType when you want to send a message campaign to users after they have sent a message beforehand.
The reactive sendType only allows sending a campaign through an integration (e.g., AutoReply way) but not through the sending endpoints.

In both cases, there may be limitations on certain message formats depending on the channel or channels through which the campaign will be sent.

Allowed:

messageContent

array of objects

required

length between 1 and 5

List of message contents to be sent to all contacts in the application.

You must define at least one message, and up to a maximum of five messages can be provided.

Variables enclosed in double curly braces {{variable}} are resolved using the root customFields property.

messageContent*

customFields

object

Variables to be used in the message content.
The keys are the variable names and the values are the variable values.
The variables will be replaced in the message content before sending.

Variables should use letters, numbers, or underscores.

scheduleAt

date-time

The date and time when the messages should be sent.
If not provided, the messages will be sent immediately.

The format must be in ISO 8601 (e.g., 2025-10-01T12:15:00Z).

The scheduling date must be within the range from now up to a maximum of 3 months into the future.

delay

string

^P(?!$)(?:(?:\d+Y)?(?:\d+M)?(?:\d+W)?(?:\d+D)?(?:T(?:\d+H)?(?:\d+M)?(?:\d+(?:\.\d+)?S)?)?)$

The delay before sending the messages.
The use of this property will schedule the sending of the messages to be sent after the specified delay from the current time.

This property can not be used in conjunction with the scheduleAt property.

The format must be in ISO 8601 duration.

Examples:

PT0.25S for 250 milliseconds
PT20S for 20 seconds
PT15M for 15 minutes
PT30M50.5S for 30 minutes, 50 seconds and 500 milliseconds
PT4H for 4 hours
P3D for 3 days
P2W for 2 weeks
P1M for 1 month

slicingCondition

string

enum

Defaults to fragmentedSlots

The slicing condition allows you to define how the messages should be sliced when sending them.

fragmentedSlots: If slicing is enabled, slots will be assigned based on availability starting from the scheduled time, regardless of whether they are consecutive, and only within the next 48 hours.
immediateConsecutiveSlots: If slicing is enabled, slots will be assigned based on availability starting from the current time (or from the scheduled time,
if it's a scheduled sending), and within the next 48 hours — but only if they are consecutive.
If not enough consecutive slots are found, the task will be marked as canceled and will not be executed.
deferredConsecutiveSlots: If slicing is enabled, the system will attempt to find the first set of consecutive available slots starting from the current time
(or from the scheduled time, if it's a scheduled sending) and within the next 48 hours.
Unlike immediateConsecutiveSlots, the consecutive block does not need to start in the first evaluated slot, so fully occupied slots can be skipped until a valid block is found.
If no suitable consecutive block is found, the task will be marked as canceled and will not be executed.

If not provided, the default condition is fragmentedSlots.

Keep in mind that these conditions will only apply to a given sending when the slicing activation criteria are met.
Also, any slots that fall within the configured forbiddenHourRanges will be considered unavailable for all slicing strategies.

Allowed:

overrideProactiveRestrictions

boolean

Defaults to false

If true, allows overriding proactive messaging restrictions.
This requires the 'proactiveRestrictionOverride' feature to be enabled in the application's configuration.
If false or not provided, default contact-level restrictions apply.

keepTypebotSession

boolean

Defaults to false

If true, preserves the current Typebot session for contacts in this sending.
If false or not provided, proactive sendings clear the session when the Typebot integration exists and is enabled.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Retrieve information about all sent messages

400Bad request

403Forbidden

500Internal server error