v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Customers actions

Set a new customer status

The method sets a new customer status. If another valid status exists, CareCloud deactivates it.

Customer statuses represent the customer's tier or standing within a loyalty program. Only one status can be active at a time. Setting a new status automatically deactivates any currently active status on the account. The response returns the ID of the created status record.

To view current and past status records on a customer account, use GET /customers/{customer_id}/statuses.

⚠️ Action method is available only in the Enterprise interface.

post/customers/actions/set-status-record

Request body

status_idstring required

The unique ID of the status.

customer_idstring required

The unique ID of the customer.

valid_fromstring

Date and time of the status record starts its validity. If not set, current date and time is applied. (YYYY-MM-DD HH:MM:SS)

valid_tostring

Date and time of the record valid to. If not set, validity from the status definition is applied. (YYYY-MM-DD HH:MM:SS)

Example request

{
  "status_id": "86e05affc7a7abefcd513ab400",
  "customer_id": "89ac83ca207a820c62c79bf03a",
  "valid_from": "2021-01-28 00:00:00",
  "valid_to": "2021-05-28 23:59:59"
}

Response

Example response

{
  "data": {
    "status_record_id": "8ea2591121e636086a4a9c0992"
  }
}