Operations related to mobile push subscriptions.
Register a mobile device for push notifications
POST /api/v4/user/push_subscriptions
Idempotently registers the calling user’s device token for APNs push notifications. Re-registering an existing token refreshes its attributes; a token previously owned by another user is reassigned to the calling user.
Request body (application/json)
| Property | Type | Description |
|---|---|---|
apns_ | String | The APNs environment the token was issued for Allowed values: production,sandboxDefault: production |
app_ | String | The installed application version |
bundle_ | String | The application bundle identifier |
device_ | String | A human- |
device_Required | String | The hexadecimal APNs device token |
locale | String | The device locale |
payload_ | String | Whether notifications carry the full content or only identifiers Allowed values: full,id_ |
platform | String | The device platform Allowed values: ios,macos |
Responses
| Code | Description | Schema |
|---|---|---|
201 | Created | APIEntities |
400 | Bad Request | — |
401 | Unauthorized | — |
404 | Not Found | — |
Unregister a mobile device from push notifications
DELETE /api/v4/user/push_subscriptions
Removes the calling user’s push subscriptions for the given device token.
Parameters
| Name | Type | Description |
|---|---|---|
device_Query, | String | The hexadecimal APNs device token |
Responses
| Code | Description | Schema |
|---|---|---|
204 | No Content | — |
400 | Bad Request | — |
401 | Unauthorized | — |
404 | Not Found | — |
Schemas
Objects returned by the operations above and objects nested in their request bodies.
APIEntitiesMobilePushSubscription
| Property | Type | Description |
|---|---|---|
created_ | String (date- | Example:2026- |
id | Integer (int64) | Example:1 |