Skip to main content
POST
notify.preferences.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
subscriberId
string
required

Your own subscriber identifier, scoped to your connected account.

Required string length: 1 - 200
preferenceSetKey
string

Caller-defined preference set; default set when omitted.

Required string length: 1 - 200
topicKey
string

Caller-defined topic, where supported.

Required string length: 1 - 200

Response

The result

entries
object[]
required

Explicit preference choices; omitted conditional choices are not global toggles.

Maximum array length: 200