API Reference

Set a new customer status

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

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.

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

The unique ID of the status.

string
required

The unique ID of the customer.

string

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)

string

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

Responses

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