API Reference

Create a new customer

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

Add a new customer account in the CareCloud platform.

Partner assignment

When a new customer account is created, CareCloud creates one or more customer-partner relations automatically. The assignment depends on the project configuration:

  • If the project is configured for store-based partner assignment and store_id is set in personal_information - a single relation is created for the partner derived from the store.
  • If the project is not configured for store-based partner assignment - relations are created for all partners accessible to the authenticated API user. The store_id, if set, is still recorded on the customer account but does not determine partner assignment.

To control partner assignment explicitly after registration, use POST /customers/actions/set-partners (enterprise interface only), which replaces all partner assignments in a single call.

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

Basic information about a customer.

customer_source
object
required

Customer source.

password

Password of the customer. Password must satisfy the following criteria and contain: At least one number (Example: 1 2 3); At least one uppercase letter (Example: A B C); Minimum lenght of password is 8 characters; Password is not part of a common password list (Example: abc123, password, 12345). If parameter autologin=true, password is required, otherwise is optional.

boolean
required

If true, password is required and customer is logged in. Otherwise password is optional.

social_network_credentials
object

This is the customer’s social media credentials.
Special Rule for PUT Request with social network credentials: Unlike typical HTTP PUT requests, the request will not erase existing data if parameters are missing. If you do not include the social media credentials in the PUT request, the existing credentials will remain unchanged.

property_records
array of objects

List of customer property records.

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

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

Responses

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 about 1 month 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 about 1 month ago