Sign in

v2

latestOpenAPI 3.1.02026-07-26231357386.7 KB
Messaging

Send Messages To Contacts

To send messages to a list of contacts in bulk

  • widget_id: Widget ID to be used for sending the message. It must be connected to WhatsApp or SMS.
  • contact_ids: list of contact IDs to whom the message is to be sent.
  • message: text message to be sent.
  • start_new_conversation: whether to start a new conversation or pick the latest.
post/api/v1/messaging/{widget_id}/contacts

Path parameters

widget_idstring uuid required

Request body

contact_idsstring[] required

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

messagestring nullable

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

start_new_conversationboolean nullable

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

Example request

{
  "contact_ids": [
    "a3ae8c0f-2e9d-4c18-8c0e-d510e3cacb04",
    "8a849d72-93cf-4e6c-b1a3-6c10d4c65f1d"
  ],
  "message": "Hi Adam, check out our new offer!",
  "start_new_conversation": true
}

Response

Successful Response

{"stackTrail":"paths:/api/v1/messaging/{widget_id}/contacts:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}