cigchat_broadcast_by_segment
Broadcast a sub flow to targeted subscriber segments via email, SMS, WhatsApp, or Facebook. Estimate audience first, then confirm to send.
Instructions
Broadcast sub flow by segments, available types: EMAIL,SMS,WHATSAPP_TEMPLATE,FACEBOOK_NOTIFICATION [POST /subscriber/broadcast-by-segment] DANGEROUS: sends to many subscribers at once, costs money and cannot be undone. Call once without confirm to get an audience estimate, show it to the human, and only then re-call with the confirmation token. Requires the "Manage Flow" scope on the token.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | available values: EMAIL,SMS,WHATSAPP_TEMPLATE,FACEBOOK_NOTIFICATION Example: EMAIL | |
| confirm | No | Confirmation token from this tool's previous "requires_confirmation" response. Call without it first, show the human the impact statement, and only pass the token once they have approved. | |
| bot_fields | No | up to 10 bot fields | |
| segment_ns | Yes | comma separated segment ns, up to 10 segment ns Accepts either the segment namespace id or the segment's exact name — the server resolves names automatically. Example: f123sg34,f123sg56 | |
| message_tag | No | when type is FACEBOOK_NOTIFICATION, available values: CONFIRMED_EVENT_UPDATE,POST_PURCHASE_UPDATE,ACCOUNT_UPDATE,NON_PROMOTIONAL_SUBSCRIPTION Example: POST_PURCHASE_UPDATE | |
| sub_flow_ns | Yes | Accepts either the flow namespace id or the flow's exact name — the server resolves names automatically. Example: f123s789 | |
| max_per_minute | No | Rate limit, maximum per minute, default is 60 Example: 60 | |
| scheduled_time | No | unix timestamp, e.g. 1786123679. Leave empty to send now Example: 1786123679 |