Skip to main content
POST
Add a push notification device to a contact

Authorizations

X-API-Key
string
header
required

An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.

Headers

X-Organization-Id
string<uuid>

Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.

Path Parameters

contactId
string
required

Body

application/json
deviceToken
string
required
platform
enum<string>
required
Available options:
ios,
android,
web
appVersion
string
deviceInfo
object
isPrimary
boolean

Response

success
boolean
required
Example:

true

message
string
required
data
object
required