Broadcasts

Send transactional broadcast

Fire a transactional broadcast for a single recipient. Fans out across the broadcast templates: one BroadcastRecipient row is created per template (sent or skipped).

post/orgs/broadcasts/{broadcast_id}/send

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/broadcasts/{broadcast_id}/send
  • Auth: HTTP bearer

Path parameters

broadcast_idstring required

Broadcast ID

Request body

contact_channel_idstring

Tier 1 (most specific): exact ContactChannel id. Skips contact resolution and channel-availability filter since the caller has chosen the channel.

contact_idstring

Tier 2: known Contact id. Channel is inferred per template at send time.

phonestring

Raw phone. When no contact is resolved by contact_channel_id/contact_id, it find-or-creates a contact by phone. When a contact is resolved, it overrides the phone used for this send only (the contact and its channels are not modified).

emailstring

Raw email. When no contact is resolved by contact_channel_id/contact_id, it find-or-creates a contact by email. When a contact is resolved, it overrides the email used for this send only (the contact and its channels are not modified).

namestring

Optional display name override for this send only. Takes precedence over the resolved channel and contact name. Does not resolve or create a contact on its own and does not modify the contact.

subjectstring

Replaces the configured subject on every email template of this broadcast, for this send only. Supports {{variable}} placeholders.

bodystring

Replaces the configured body (HTML) on every email template of this broadcast, for this send only. Supports {{variable}} placeholders.

messagestring

Replaces the configured message text on every SMS template of this broadcast, for this send only. Supports {{variable}} placeholders.

reply_tostring

Replaces the configured reply-to address on every email template of this broadcast, for this send only. Supports {{variable}} placeholders.

variablesobject

Per-recipient values by name: a template slot (a WhatsApp variable such as body_1 or body_customer_name, an email subject, an SMS message) or a {{name}} written in a template. A slot you omit goes out as configured in the channel editor.

template_idsstring[]

Optional subset of broadcast templates to fire. Omit to fire all templates on the broadcast.

backgroundboolean

When false (default), the call awaits the send and returns external_message_id per template. When true, the call enqueues and returns immediately.

Response

Changes

No recorded changes to this operation across all 1 revision of this API.