Skip to main content
POST
notify.subscriber.upsert

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
mode
enum<string>
default:merge

Merge supplied fields or replace the whole profile where supported.

Available options:
merge,
replace
firstName
string

Subscriber first name.

Required string length: 1 - 320
lastName
string

Subscriber last name.

Required string length: 1 - 320
name
string

Subscriber display name.

Required string length: 1 - 320
locale
string

Subscriber locale.

Required string length: 1 - 320
timezone
string

Subscriber time zone.

Required string length: 1 - 320
email
string

Subscriber email, only when contacts are requested.

Required string length: 1 - 320
phone
string

Subscriber phone, only when contacts are requested.

Required string length: 1 - 320
tags
object

Up to 20 caller-defined tags; merged unless replacement is supported.

Response

The result

subscriberId
string
required

Your own subscriber identifier.

acknowledged
boolean
required

The profile write was acknowledged, without claiming readback.