API Reference

Cancel the customer's push notifications subscription from all devices if push token not specified.

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers/actions/cancel-push-notifications

Cancel push notification subscriptions for a customer.

Unregisters a customer's push notification token for a specified external application. If push_token is provided, only that specific device registration is removed. If push_token is omitted, all device registrations for the customer and application are cancelled.

To register a device for push notifications, use POST /customers/actions/set-push-notifications (enterprise interface only).

⚠️ The endpoint is available only in the Enterprise interface.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The unique ID of the customer.

string
required

ID of the external application. More information about external applications and how to get an ID is available in Authentication section.

string

Push notification token (Apple or Google).

Responses
204

No Content

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 3 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago