Skip to main content
POST
notify.message.send

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
subscriberId
string
required

Your own subscriber identifier, scoped to your connected account.

Required string length: 1 - 200
channel
enum<string>
required

Exactly one delivery channel.

Available options:
push,
inbox,
email,
sms
body
string
required

Message body.

Required string length: 1 - 3000
title
string

Message title.

Required string length: 1 - 200
data
object

Up to 20 string values sent with the notification.

Response

The result

accepted
boolean
required

The service accepted the request; this is not proof of delivery.

state
enum<string>
required

Known send state.

Available options:
accepted,
queued,
sent,
handed_off,
delivered,
failed,
canceled,
pending,
unknown
ref
string

Reference to what this call created. Pass it as ref to notification status and follow-up calls.