Skip to main content
POST
notify.message.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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
ref
string
required

The ref returned by an earlier notification create or list call.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
includeContent
boolean
default:false

Include personal message content when available.

Response

The result

state
enum<string>
required

Known delivery state; unknown when no evidence is available.

Available options:
accepted,
queued,
sent,
handed_off,
delivered,
failed,
canceled,
pending,
unknown
channel
enum<string>
required

Delivery channel when known.

Available options:
push,
email,
sms,
inbox,
chat,
unknown
createdAt
string

Creation time, ISO 8601.

updatedAt
string

Last status time, ISO 8601.

title
string

Requested message title, without contact details.

body
string

Requested message body, without contact details.