try out ↗

← API Index


/api/client/registerpushtoken

Register an FCM device token; works for guests (no session) as well as logged-on customers

Parameters

Name Description Type
token FCM device registration token string
platform device platform: android or ios string
reportsAnalytics true if this app build calls api/client/pushdelivered and pushopened; defaults to false boolean
claimToken opaque device-claim token from a previous registered/registered_via_claim response; presented instead of a session to re-associate this device, e.g. after FCM token rotation while logged out string
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Error Responses

HTTP Status Error Code Description
400 error General error registering device token
400 parameter_error Missing or invalid parameter
400 invalid_apikey Missing or unrecognized x-oo-apikey

Response Types

Type Version Description
DeviceRegistration 1 Result of a device push-token registration, including a rotated claim token when the device was associated with a customer
ActionResult 0 Result of a backend action

OpenAPI

See registerpushtoken.yaml

Referenced in skills