Register push device in domain

POST

/domains/{domain}/push

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

OperationId:RegisterPushConfigurationDomain

Registers a device's push token so the device gets call and message notifications in one domain. 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:

Reseller manages registrations in domains of its territory.

Super User manages any domain.

Scopes below Reseller, except the read-only ones, manage only their own registrations in their own domain. Add user with your own user (or ~).

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. push-device must be a device in the path's domain, and your own below Reseller.

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 ********************

Path Params

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/domains/example.com/push' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user": "1001",
    "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:32

Unregister push device

Update push registration in domain