Push

Register or refresh this app installation for push

Upserts the installation (keyed by installation_id, which the app generates once). Reporting a token another installation holds moves it here. app_state=foreground also records that the user has the app open (used to hold back sync nudges).

put/api/push/installation

Request

  • Base URL
    https://api.hiyd.ai
  • Auth
    HTTP bearer

Request body

installation_idstring required
fcm_tokenstring nullable

null = no token yet; a token already stored for this installation is kept

platform'ios' | 'android' required
firebase_projectstring nullable
app_versionstring nullable
localestring nullable
timezonestring nullable

IANA zone, stored under its canonical name; an unknown zone is stored as null

authorization_status'authorized' | 'provisional' | 'denied' | 'not_determined' | 'ephemeral' | 'unknown'
capabilitiesstring[]
app_state'foreground' | 'background'

Response

The stored installation, the user's notification preferences and the server clock

Changes

No recorded changes to this operation across all 1 revision of this API.