Create a new customer

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

Add a new customer account in CRM CareCloud.

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.

autologin

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 an customer property records.

property_records

Headers

Accept-Language

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.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/customers \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '{"autologin":true}'


xxxxxxxxxx
 
1
{
2
  "data": {
3
    "customer_id": "8ea6abece4cd0a4ded0a29f093"
4
  }
5
}

201Created

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.