Skip to main content
POST
notify.push.validate

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

Device push token, forwarded once and never returned.

Required string length: 1 - 4096
body
string
required

Notification body, sent exactly as supplied.

Required string length: 1 - 3000
title
string

Notification title.

Required string length: 1 - 200
data
object

Up to 20 string values sent with the notification.

ttlSeconds
integer

Seconds before an undelivered notification expires.

Required range: 0 <= x <= 2419200

Response

The result

valid
boolean
required

The message passed service validation; no notification was sent.