Bulk calling

To initiate calls to a list of contacts in bulk

POST /api/v1/call/{widget_id}/contacts

Bulk calling

cURL

curl --request POST \
  --url 'https://api.example.com/api/v1/call/{widget_id}/contacts?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_ids": [
    "a3ae8c0f-2e9d-4c18-8c0e-d510e3cacb04",
    "8a849d72-93cf-4e6c-b1a3-6c10d4c65f1d"
  ],
  "message": "Hi Adam, check out our new offer!",
  "start_new_conversation": true
}
'

200

{
  "status": "Campaign has been queued"
}

Authorizations

api_key · string · query · required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

widget_id · string<uuid> · required

Widget ID to be used for initiating the call. It must be connected to Twilio, Plivo or Telnyx.

Body

application/json

Payload containing the list of contact IDs and other details.

contact_ids · string<uuid>[] · required

List of UUIDs that identify the contacts to receive the campaign.

Minimum array length: 1

Example:

[
  "a3ae8c0f-2e9d-4c18-8c0e-d510e3cacb04",
  "8a849d72-93cf-4e6c-b1a3-6c10d4c65f1d"
]

message · string | null

(Only for Chat based assistants, ignored for calling) Message to be sent

Example:

"Hi Adam, check out our new offer!"

start_new_conversation · boolean | null · default: false

(Always True for calling campaigns) Start a brand‑new thread instead of replying in the existing one.

Example:

true

Response

200

application/json

Campaign has been qeueud

message · string | null · default: Data created successfully

meta · Meta · object

data · unknown