Skip to main content
POST
Create SMS campaign
Creates an SMS campaign. Optionally launches it immediately.
Campaigns are one-time broadcasts. Replies are handled by the agent using its system_prompt — include any campaign context in the agent’s prompt before launching.

Request

Body parameters

Recipient object

Placeholders

Use {{variable_name}} in message_template. Each recipient’s variables object fills them. Template: Hi {{first_name}}, see you on {{day}}. Recipient: { "phone": "+44...", "variables": { "first_name": "Sarah", "day": "Tuesday" } } Sent SMS: Hi Sarah, see you on Tuesday. Missing variables render as empty strings (no crash).

Response

201 Created:
When schedule_type is now, returns status: running and sends immediately. With schedule, returns status: scheduled — launch later with Launch SMS campaign.

Errors

See Errors. Common: agent_not_owned, from_number_not_owned, too_many_recipients, invalid_schedule.