v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Customers actions

Set the customer's 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.

post/customers/actions/set-push-notifications

Request body

customer_idstring required

The unique ID of the customer.

external_application_idstring required

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

push_tokenstring required

Push notification token (Apple or Google).

Example request

{
  "customer_id": "8ea2591121e636086a4a9c0992",
  "device": {
    "device_id": "00000000-89ABCDEF-01234567-89ABCDEF",
    "device_system": "OSX",
    "device_name": "Test device",
    "device_type": "iPhone"
  },
  "external_application_id": "82de12eb8b138791e678fd11c3",
  "push_token": "4f7f658bfa7a5959e093590"
}

Response

No Content