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_…. Use a scoped token with MESSAGES_SEND and an explicit connector grant. The request body is a flat JSON object — any key besides the three below is substituted into the template as a {{placeholder}}.
Create least-privilege API tokens
For a customer connector, grant scopes: ["MESSAGES_SEND"] and list its ID in allowedConnectorIds. To use Flextuma's paid shared connector, grant allowSystemConnectors: true; sends are charged to the token owner's wallet. Scoped tokens without the relevant grant are rejected.
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.
connectorId UUID optional
Explicit connector selection. A token must be granted access to this connector.
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.