Skip to main content
PUT
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

user_id
string
required

The user's ID. This can be any uniquely identifiable string.

token
string
required

The full token string.

Body

application/json

Request body for adding a single token. The token value itself is provided via the path parameter, so it is omitted from the body.

provider_key
enum<string>
required
Available options:
firebase-fcm,
apn,
expo,
onesignal
expiry_date

When the token expires. Accepts a date, or the boolean false to disable expiration entirely. ISO 8601 is recommended (for example 2026-10-25T00:00:00.000Z). A value that cannot be parsed as a date is rejected; it is not treated as "no expiration" and does not fall back to the default. true is not a supported value. Omit the field to use the default, which expires a token that has not been re-registered for 60 days.

properties
any | null

Properties about the token.

device
UsersDevice · object | null

Information about the device the token came from.

tracking
usersTracking · object | null

Tracking information about the device the token came from.

Response