Skip to main content
POST
notify.device.create

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

Personal push token, forwarded once and never returned.

Required string length: 1 - 4096
platform
enum<string>
required

Device platform.

Available options:
ios,
android,
web
transport
enum<string>
default:native

Native platform token or managed push token.

Available options:
native,
managed
enabled
boolean
default:true

Allow notifications to this device.

Response

The result

acknowledged
boolean
required

The registration was acknowledged.

ref
string

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