Kapso API icon

Kapso API

Send WhatsApp messages, templates, flows, media, contacts, broadcasts, and inbox records through Kapso. Choose a resource, then follow each operation setup hints.

Broadcast → Add Recipients to Broadcast

AI-generated

Summary

Adds recipients to an existing Kapso WhatsApp broadcast campaign that is still in Draft status. Recipients are either built in the node or mapped from upstream items, with template variables, header and button values taken from the broadcast's template.

Inputs

  • Broadcast (required) — The draft broadcast to add recipients to. Pick it from a searchable list or enter its UUID. Recipients can only be added while its status is Draft.
  • Recipient Source — Recipients Builder (default) lets you define recipients in the node. From Input Items treats each incoming item as one recipient.
  • Phone JSON Field (required) — Input Items mode only. Name of the JSON key that holds the E.164 phone number (default 'phone').
  • Contact ID JSON Field — Input Items mode only. JSON key holding an existing Kapso contact UUID, used when the item has no phone.
  • Recipients (required) — Builder mode only. One entry per recipient. Each has a phone number in E.164 format (+15551234567) and an optional Kapso contact ID. Body text parameters, header values (text, media link or ID, or location) and button parameters (URL, quick reply, flow, copy code, catalog, MPM) follow the detected template. Carousel templates use card index, header media and button parameters per card. Advanced Components JSON can override these fields for a single recipient with a raw Meta components array.
  • Recipients Body JSON (Advanced) — Builder mode only. Full Kapso recipients payload for cases the builder cannot express. Not used with From Input Items.

Output shape

The JSON response from the Kapso API for the add-recipients request, returned as an item for each execution.

The node checks that the broadcast is in Draft before sending. Kapso accepts up to 1,000 recipients per request, so split larger lists across several nodes. The exact response fields are not defined in the provided source.

Examples

Example 1: Add a few recipients by hand to a draft broadcast

Select the broadcast, keep Recipient Source as Recipients Builder, add recipients with a phone number and map the body parameters.

Example 2: Load recipients from a spreadsheet or database

Set Recipient Source to From Input Items, set Phone JSON Field to 'phone', and make each upstream item carry keys for the template variables.

Example 3: Send with prebuilt Kapso payload JSON

Use builder mode and paste the full payload into Recipients Body JSON (Advanced).

Links

Discussion