send_message
Queue ONE email and/or SMS, written by you, to one of your OWN participants. SENDS A REAL MESSAGE — it leaves the platform and cannot be recalled. There is no address field: the recipient is a participant token inside the account, so this cannot be used to message anyone else. confirm=true is REQUIRED; set it only after the user approved the exact text going to that participant. Plain text only, max 5,000 characters — but 1,600 when the channel includes SMS, so keep it short if sending by SMS. Rate limits (200 per API key per 24h, 3 per recipient per 24h) and the account suppression list are enforced server-side. Pass idempotency_key only if the user supplied one; do not invent one. Requires the Send Message module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support. When a send is refused, call fetch_messaging_usage first: it is what distinguishes module access, plan channels, an exhausted allowance, a sending pause and a missing 10DLC number. Direct sending is a SEPARATE account switch from the module: fetch_messaging_usage can report ModuleEnabled true while DirectMessageEnabled is false, and this call then returns 403 "Direct messages through the API are not enabled for your account yet" (observed in production 2026-09-30). That is account configuration, not a bug — do NOT retry; tell the user to contact Sweeppea support.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| channel | Yes | email, sms or both. both sends on each channel the participant has a usable address for | |
| confirm | Yes | Must be true. Set it ONLY after the user explicitly approved THIS action in this conversation, having been told what it does and that it cannot be taken back: a real email and/or SMS with this exact text goes out to that participant and cannot be recalled. Never assume, never carry an approval over from a previous item, never set it to satisfy the schema. | |
| message | Yes | Plain text. Max 5,000 characters — max 1,600 when the channel includes SMS | |
| subject | No | Email subject, max 200 characters. Line breaks are collapsed. Defaults to a generic subject | |
| idempotency_key | No | Optional, 8 to 64 characters [A-Za-z0-9_-]. Retrying with the same key never sends twice. Only pass one the user supplied | |
| participant_token | Yes | The participant token (UUID v4) of a participant (regular or AMOE) of your account |