Documentation

Route (Messages)

Transactional outbound messaging on SMS, email, push, and WhatsApp.

The Route service delivers outbound messages. POST to /v1/route/messages with channel, recipient, and body.

POST /v1/route/messagesJSON

{
  "channel": "whatsapp",
  "to": "+233241234567",
  "body": "Your order #1234 has shipped."
}

Supported channels

sms
email
push (FCM + APNs — see Push docs)
whatsapp (text and approved templates)

Push notification

POST /v1/route/messages (push)JSON

{
  "channel": "push",
  "to": "user:usr_demo",
  "push": {
    "title": "Order shipped",
    "body": "Your package is on the way.",
    "data": { "orderId": "12345" },
    "badge": 1,
    "sound": "default"
  }
}

Requires route:messages:write permission and the push feature. Configure FCM/APNs in the console or via /v1/engage/push/config before sending.

WhatsApp and push channels also require their respective feature entitlements. Returns 202 when queued.