POST
Register push device

Authorizations

Authorization
string
header
required

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

Body

application/json

JSON payload used to register push device.

Request payload for register push device.

platform
string
required

platform value for register push device request.

Required string length: 1 - 20
device_token
string
required

device token value for register push device request.

Required string length: 1 - 4096
label
string | null

label value for register push device request.

Maximum string length: 120
app_instance_id
string | null

UUID identifier for app instance.

Maximum string length: 160

Response

Registered or refreshed a push device for the authenticated landlord or tenant principal

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.