Register push device

POST

/push

Last modified:2026-10-03 07:43:29

OperationId:RegisterPushConfigurationSystem

Registers a device's push token so the device gets call and message notifications anywhere on the platform. A mobile or web app calls it after it gets a token from its push service, and again whenever that token changes.

Who can call it:

Every scope except the read-only ones can register a device it owns. Below Reseller, the body must name you: add "user": "~", or your own domain and user. Without them the request gets 403.

Reseller registers any device in a domain of its territory.

Super User registers any device.

Super User Read Only and Office Manager Read-Only get 403.

What happens:

push-device must be an existing device within your reach. Any other answers 404 with Device not found., whether the device is missing or someone else's.

The registration belongs to the device's owner, taken from the device. domain and user in the body only identify you; they never change the owner. Below Reseller the owner must be you.

Push delivery is switched on for the device if it is not already.

The token replaces any other token on the same device and push-network, so a device holds one token per push service.

push-network defaults to firebase. A pwa token is URL-decoded before it is checked and stored.

Answers 202 with {"response": "ok", "device": ...}. The change is accepted and applied shortly after, so a read made straight after it can still show the previous state.

An apns registration returns 400 when the platform is not set up for Apple push. Contact support. To remove the registration, see the matching DELETE.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢202Accepted

application/json

Accepted; applied shortly after. The body names the device.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

cURL

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/push' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user": "~",
    "push-device": "sip:1001a@example.com",
    "push-device-token": "a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8f90",
    "push-network": "apns",
    "push-test": "no"
}'

Response Example

202 - Registered

Accepted; applied shortly after.

{
    "response": "ok",
    "device": "sip:1001a@example.com"
}

Modified at 2026-10-03 07:43:29

Unregister push device for user

Update push registration