sms-marketing

List all SMS templates in your workspace. Returns an array of template objects with id, name, body, is_active, created_at, and updated_at fields.

Create a new reusable SMS template. Supports variables that are replaced at send time: {{first_name}}, {{last_name}}, {{promo_code}}, {{recovery_url}}. Returns the created template with its UUID.

Update an existing SMS template by its UUID. Only provided fields are modified; others remain unchanged.

Permanently delete an SMS template by its UUID. This action cannot be undone. Campaigns referencing this template will lose their template link.

List contacts in your workspace with pagination and optional filters. Returns contacts with id, phone, first_name, last_name, email, tags, metadata, opted_out status, and timestamps.

Add a new contact to your workspace. The phone number is automatically normalized to E.164 international format. French numbers (06/07) are converted to +33 format. Returns the created contact with it…

Update an existing contact by UUID. Only provided fields are modified. Use this to change names, email, tags, or metadata without affecting other fields.

Permanently delete a contact by UUID. This removes the contact and all associated data. Cannot be undone.

Bulk import up to 1,000 contacts at once. Uses upsert on phone number: existing contacts are updated, new ones are created. Returns count of imported and skipped contacts.

List all SMS campaigns in your workspace. Optionally filter by status. Returns campaigns with id, name, message, status, scheduled_at, sent_at, target_filter, and stats.

Create a new SMS campaign in draft status. Provide either a direct message or a template_id. Use send_campaign to actually dispatch it. Optionally set target_filter to send to a subset of contacts.

Update a draft or scheduled campaign. Only draft and scheduled campaigns can be modified. Sent or cancelled campaigns cannot be updated.

Permanently delete a campaign. Only campaigns in 'draft' or 'cancelled' status can be deleted. Sent campaigns are preserved for audit.

Send a draft campaign immediately to all matching contacts. Credit cost depends on each recipient's destination country and the number of SMS parts. Each SMS is debited as it leaves and refunded if th…

Get the results of a campaign. For an A/B test: per version, SMS sent, failed, human clicks and click rate (link previews and scanners excluded), the test phase, the decision time, the winner and why …

Send a single SMS message to a phone number immediately. Credit cost depends on the destination country and the number of SMS parts (160 chars = 1 part, longer messages use multiple parts). The messag…

List SMS sending logs with pagination and optional filters. Returns log entries with phone, message, status (pending/sent/delivered/failed), provider_id, error_message, and timestamps.

List all phone numbers that have opted out of receiving SMS. These contacts will be automatically excluded from campaigns and direct sends.

Add a phone number to the opt-out list. This contact will no longer receive any SMS. The corresponding contact record is also marked as opted_out.

Remove a phone number from the opt-out list, allowing them to receive SMS again. The corresponding contact is also marked as opted back in.

Get your workspace information including name, plan status, SMS credit balance, billing cycle start date, and timezone. Use this to check available credits before sending SMS.

Get aggregated SMS sending statistics for a date range. Returns counts by status: pending, sent, delivered, failed, and total. Useful for monitoring delivery rates and campaign performance.

Calculate how many SMS parts a message will use and the character count. Does NOT send anything. This is a free, read-only utility. Use this before sending to estimate credit cost. GSM-7 encoding: 160…

Get the SMS credit cost for a specific phone number or country. Shows the destination country and credits per SMS. Use this to estimate costs before sending. Covers 90+ countries.

Guide the agent through creating and sending an SMS campaign to a specific contact segment. Walks through template selection, contact filtering, and sending.

Guide the agent through importing a batch of contacts, creating a welcome template, and sending a first SMS campaign.

Guide the agent through reviewing SMS delivery stats, checking failed sends, and analyzing campaign performance.