API Reference

Set one or multiple partners to the customer

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

Set one or multiple partners to the customer.
The method will set all the partners from the request available to the CareCloud API user and delete all that are not present in the request.
If customer has a partner that is unavailable to the user, this partner is not going to be modified or deleted.
⚠️ 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.

partner_records
array of objects
required
length ≤ 1000

Collection of all customer partner records.

partner_records*
Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

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 4 months ago

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

Updated 4 months ago

Did this page help you?