API Reference

Set the customer's push notifications

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

Set up customer push notifications for a specific application and device.

Registers a push notification token (Apple or Android) for a customer account and links it to the specified external application and device ID. This enables the CareCloud platform to send push notifications to the customer's device. If a token is already registered for the same device ID, it is replaced.

To unregister a device, use POST /customers/actions/cancel-push-notifications (enterprise interface only).

⚠️ The endpoint is available only in the Enterprise interface.
⚠️ Please make sure the ID of the device is unique. You will avoid problems with signing off other devices.

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.

device
object
required

Structure describes the client device or browser.

string
required

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

string
required

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