Skip to main content

​
Base URL

All API requests are sent to your project endpoint:
Replace :project-id with your project ID from the Lerix Dashboard under Project Settings. Example:

​
Authentication

Before you call the API, create a private key in Project Settings in the dashboard. Send the private key on every request in the lerix-key header:
Keep your private key secret. Do not commit it to source control, expose it in client-side code, or share it publicly.

​
Next steps

Push Notifications

Send push notifications through the REST API.

Update a Notification

Change a notification’s title and body.

Unsend a Notification

Remove an already-delivered notification from devices.

Cancel a Scheduled Notification

Stop a scheduled notification before it goes out.

Get Delivery Status

Read per-recipient delivery outcomes.

Error & success codes

Reference common API response codes.