Skip to Content
LYNKORIADocs
HTTP API reference

Push notifications

Device registration, notification preferences and sending notifications. Generated from the OpenAPI specification.

Device registration, notification preferences and sending notifications.

GET /v1/push/devices

Push registrations of the signed-in user.

Authentication: Messaging token (Authorization: Bearer <token>), from the user’s device.

Response 200 OK

FieldTypeRequiredNotes
devicesobject[]Yes
devices[].idstring (uuid)Yes
devices[].deviceIdstringYes
devices[].platform"android", "ios"Yes
devices[].provider"fcm", "apns", "apns_voip"Yes
devices[].appIdstringYes
devices[].updatedAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

PUT /v1/push/devices

Register or refresh this device’s push token (idempotent; call on every token refresh).

Authentication: Messaging token (Authorization: Bearer <token>), from the user’s device.

Request body (application/json, required)

FieldTypeRequiredNotes
platform"android", "ios"Yes
provider"fcm", "apns", "apns_voip"Yes
tokenstringYespattern ^[A-Za-z0-9:_.-]{16,4096}$
appIdstringYespattern ^[A-Za-z0-9._-]{1,200}$
apnsEnvironment"sandbox", "production"No

Response 200 OK

FieldTypeRequiredNotes
idstring (uuid)Yes
deviceIdstringYes
platform"android", "ios"Yes
provider"fcm", "apns", "apns_voip"Yes
appIdstringYes
updatedAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

DELETE /v1/push/devices

Unregister this device (on sign-out); optionally only one provider.

Authentication: Messaging token (Authorization: Bearer <token>), from the user’s device.

Query parameters

FieldTypeRequiredNotes
provider"fcm", "apns", "apns_voip"No

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/push/preferences

Authentication: Messaging token (Authorization: Bearer <token>), from the user’s device.

Response 200 OK

FieldTypeRequiredNotes
callsbooleanYes
messagesbooleanYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

PUT /v1/push/preferences

Authentication: Messaging token (Authorization: Bearer <token>), from the user’s device.

Request body (application/json, required)

FieldTypeRequiredNotes
callsbooleanYes
messagesbooleanYes

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/notifications

Queue a push to users’ registered devices (message or custom kinds).

Authentication: Service key with scope messaging:write (Authorization: Bearer lynk_…), from your backend only.

Request body (application/json, required)

FieldTypeRequiredNotes
tenantIdstringNopattern ^[A-Za-z0-9._@-]{1,128}$; default "default"
userIdsstring[]Yesat least 1 items; at most 1000 items
kind"message", "custom"Nodefault "custom"
titlestringNomax length 200
bodystringNomax length 1000
datamapNodefault {}
collapseKeystringNomax length 64
ttlSecondsintegerNo≥ 0; ≤ 2419200; default 86400

Response 202 Queued

FieldTypeRequiredNotes
queuedintegerYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

On this page