Create schedule
create_scheduleSend the same text to one number every day, week or month at a local time (e.g. a weekly reminder). Every occurrence runs the usual send checks.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ||
| body | Yes | ||
| from | No | One of your numbers. Optional when the account has exactly one number for the key's mode. | |
| repeat | Yes | ||
| category | No | Optional. It can make each occurrence stricter (`marketing`), never looser: the sending number's registration and the wording decide ([which messages are marketing](/docs/compliance-checks#which-messages-are-marketing)). | |
| end_date | No | Last local date it may run (inclusive). | |
| start_date | No | First local date it may run. Defaults to today. | |
| 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: an occurrence in quiet hours is held until the recipient's 8:00am and recorded as `deferred`. | |
| idempotency_key | No | Optional. Retries are already safe: the same call with the same inputs within 10 minutes is done once and answers with the first result. Pass your own key to dedupe across a longer gap, or a new one to repeat an identical call on purpose. | |
| max_occurrences | No | The schedule completes after this many messages have been sent. |