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.

What happens when a customer is created

  • A customer record is created and its server-generated customer_id is returned.

  • One or more customer-partner relations are created 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.

  • If called from the customer interface with autologin=true, the customer is logged in as part of the response.

  • If referral_code is provided and valid, a customer relation is created between the new customer and the referral code holder. The relation type used is determined by the referral campaign configuration. See GET /customers/{customer_id}/related-customers to view the resulting relation.
    Conditional requirements

  • When autologin is true, password is required.

  • When autologin is false, password is optional.

autologin is meaningful only when this endpoint is called from the customer interface. In the enterprise interface, autologin=true causes the password to be validated but does not log the customer in - the enterprise interface does not establish customer sessions.

Related operations

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
length ≤ 1000

List of customer property records.

property_records
string

Referral code of an existing customer who referred the new registrant. When provided, a customer relation is created between the new customer and the referral code holder after successful registration. This field is optional.

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

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

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 days 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 days ago