Send batch
send_batchSend one message to many people (a broadcast or campaign): pick recipients by segment_id, tags, contact_ids, or an explicit recipients list. Opted-out numbers, numbers without marketing consent, and people unsubscribed from topic_id are removed before sending. dry_run: true sends nothing and returns the count, cost, rejected rows and consent.no_opt_in (recipients the send will skip for having no opt-in). scheduled_at sends later (up to 30 days). With a live key it texts real people.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| from | No | One of your numbers. Optional while the key's mode has one number. | |
| name | No | ||
| tags | No | Send to contacts carrying any of these tags (instead of recipients). | |
| dry_run | No | Validate only: returns a BatchValidation and sends nothing. | |
| list_id | No | Send to the contacts in this list, as it is when the batch is created (instead of recipients). | |
| category | No | Optional. It can make the batch stricter (`marketing`), never looser: the sending number's registration and the wording decide ([which messages are marketing](/docs/compliance-checks#which-messages-are-marketing)). From a number with no registration, a batch is marketing. | |
| topic_id | No | Subscription topic. Recipients unsubscribed from it are removed at validation (`topic_unsubscribed`) and skipped at send time, like opt-outs. Omit to apply opt-outs only. | |
| recipients | No | ||
| segment_id | No | Send to the contacts in this saved segment, evaluated when the batch is created (instead of recipients). | |
| contact_ids | No | ||
| quiet_hours | No | Optional. What to do with a message in the recipient's quiet hours: `block` refuses it (403 quiet_hours), `defer` holds it until their next 8:00am. Omitted: each recipient in quiet hours is held until their 8:00am. | |
| scheduled_at | No | Future ISO timestamp or epoch ms, up to 30 days out. | |
| check_line_types | No | Reject landlines (first 500 unique numbers are checked). |