Actions2
Start Conversation
AI-generatedSummary
Starts a WhatsApp conversation by sending a selected template to a customer. Builds template components from the variable rows, or uses a valid JSON component override, then returns the conversation, sent message, and a rendered template preview.
Inputs
- Account (required) — WhatsApp account to send from; loads available accounts.
- Phone Number (E.164) (required) — Customer phone number in E.164 format.
- Template (required) — Template selected for the account; its value includes the language, such as
order_refused::ar. - Body Variables — Add a position and value for each body placeholder. Values can be text or expressions; omitted values are sent as empty strings for detected placeholders.
- Header Variables — Add values for text header placeholders; omitted values are sent as empty strings. Leave empty if the template has no text header placeholders.
- URL Button Values — Supply values for URL buttons with placeholders, using the button index. Leave empty if none apply.
- Copy Code Values — Supply values for COPY_CODE buttons with placeholders, using the button index. For authentication templates the parameter type is
coupon_code; other categories usetext. - Template Components (JSON override) — A non-empty JSON array of component objects, each with
typeandparameters, takes precedence over the variable rows. Invalid or empty JSON falls back to components built from the template and rows. - Integration Label — Optional label shown in the inbox (maximum 64 characters).
- Idempotency Key (X-Request-Id) — Optional request ID; replays with the same ID return the cached debit without recharging. If omitted, the node generates a request ID for the write.
Output shape
One output item per input item, each containing conversation, message, and preview fields.
The preview contains rendered body and header text where available, plus placeholder counts; it may be null if the template cannot be fetched. The API response supplies the conversation and message objects.