Register a push configuration (system scope)

POST

/push

Last modified:2026-08-21 17:26:10

OperationId:RegisterPushConfigurationSystem

The write is publish-only (NsLocalDbSave is false): the API publishes a push create on the mobile_events service bus and answers immediately. The push_config row appears when that event is consumed back by this API, so a read issued instantly after the create may not see 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 the APNS.local_cert or APNS.custom_certs config property on the server, otherwise the request is refused with 400.

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

🟢200OK

application/json

Registration published to the mobile_events service bus.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠409

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

Modified at 2026-08-21 17:26:10

Unregister a push configuration for a user

Update a push configuration (system scope)