Skip to navigation
EndpointsNotifications

Register an install for push

Call on every launch and whenever the OS issues a new token. The call is idempotent, keyed by token:

  • A token the server has not seen creates a device — 201.
  • A known token is refreshed in place — 200, never a second device — and reactivated if a delivery had marked it dead.
  • A token registered to a different user moves to the caller. A token belongs to one install, so a second user presenting it has signed in on that install, and the first user stops receiving pushes there.

Pushes carry a generic sentence and identifiers only (kind, *_id, plus category); fetch details from the API after the tap. The Android notification channel id and the iOS thread-id are the category key.

Refused for API tokens (403, token_auth_not_permitted).

Authentication

AuthorizationBearer

JWT access token obtained from POST /api/v1/auth/login, or a finput_sk_... API token

Request

This endpoint expects an object.
tokenstringRequired<=1024 characters
The FCM registration token for this install.
platformenumRequired
Allowed values:
app_environmentenumRequired
Which build registered. A development build's token is issued against APNs' sandbox and does not deliver from a production sender.
Allowed values:
timezonestringOptional<=64 characters
The phone's IANA timezone. Adopted for quiet hours unless the user has chosen a zone themselves. Send it on every registration so quiet hours follow a broker who travels.

Response

A known token, refreshed.
idintegerOptional
platformenumOptional
Allowed values:
app_environmentenumOptional
Which build registered. A development build's token is issued against APNs' sandbox and does not deliver from a production sender.
Allowed values:
is_activebooleanOptional
last_seen_atdatetimeOptional
created_atdatetimeOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error