Register a push configuration for a user

POST

/domains/{domain}/users/{user}/push

Last modified:2026-08-21 17:27:46

OperationId:RegisterPushConfigurationUser

Writes are publish-only (NsLocalDbSave is false): the API publishes a push event on the mobile_events service bus and answers immediately. The push_config row changes when that event is consumed back, so a read issued instantly after a write may not reflect it yet.

Side effects on create:

The target device's call_processing_rule gains the Push token if it does not already carry it.

Any other token already registered for the same push-device + push-network pair is deleted, so one device holds at most one token per network.

push-network: apns requires APNS.local_cert or APNS.custom_certs on the server, otherwise the request is refused with 400.

Scope: object push carries only user-tier privileges in scope_priv, so a Basic User or Office Manager token can only act on its own user (/domains/{domain}/users/{user}/push where {user} is the token's own uid). Reseller and Super User tokens reach the domain- and system-scoped forms via their wildcard scope rows.

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

🟢200

application/json

Push registration successful

Bodyapplication/json

🟠400

🟠401

🟠403

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//push' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "push-device-token": "a1b2c3d4e5f6...",
    "push-device": "1001a@example.com",
    "push-network": "firebase",
    "push-test": "yes"
}'

Response Example

200 - Example 1

{
    "response": "string",
    "device": "string"
}

Modified at 2026-08-21 17:27:46

List push configurations for a user

Update a push configuration for a user