Sending / Send a message

Send a message

Creates and queues a single outbound SMS. Billing is per SMS segment and delivery status is updated as your configured provider confirms delivery.

POST /api/notifications

Authenticate with a personal access token: send it as X-API-KEY: ft_…. The request body is a flat JSON object — any key besides the three below is substituted into the template as a {{placeholder}}.

Body parameters

phoneNumber string required

Recipient in E.164 format, for example +255700000000.

provider string required

Connector provider key configured on your account, for example beem or next.

templateCode string required

Code of an existing template on your account.

...template variables string optional

Any other key, for example name, fills the matching {{name}} placeholder in the template.

Errors

CodeMeaning

400A required field is missing, or the template has an unfilled variable.

402Wallet balance too low for this send.

404Template not found, or not accessible to your account.

429Rate limit exceeded — 10 requests/second per account.