Update a client

Update a client

POST https://api.complycube.com/v1/clients/:id

Updates the specified client by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Once a client is created, their type can no longer be amended.

Path Parameters

Name	Type	Description
id	string	The ID of the client.

Headers

Name	Type	Description
Content-Type	string	The content-type must always be set to application/json.
Authorization	string	The API live or test key

Request Body

Name	Type	Description
email	string	The client's email address.
mobile	string	The client's mobile number.
telephone	string	The client's telephone number.
externalId	string	A unique identifier that you can associate with the client. For example, this can be the client ID in your system.
joinedDate	string	The date and time when the client was registered with you. This is relevant for users that migrate existing customers. The format is YYYY-MM-DD.
personDetails	object	Primary details for a client of type person. This is required when the type is person.
companyDetails	object	Primary details for a client of type company. This is required when the type is company.

200 Client successfully updated.

{
    "id": "5eb04fcd0f3e360008035eb1",
    "type": "person",
    "email": "[e-mail]",
    "mobile": "[phone]",
    "telephone": "[phone]",
    "joinedDate": "2020-01-01",
    "personDetails": {
        "firstName": "Jane",
        "lastName": "Doe",
        "dob": "1995-12-20",
        "nationality": "US"
    },
    "createdAt": "2020-01-04T17:24:29.146Z",
    "updatedAt": "2020-01-04T17:13:10.712Z"
}

Example request

cURL

curl -X POST https://api.complycube.com/v1/clients/{:clientId} \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          	"email": "[e-mail]",
						"personDetails":{
							"firstName": "Jane",
							"lastName": "Doe",
							"dob":"1995-12-20",
							"nationality": "US"
						}
    	}'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const client = await complycube.client.update("CLIENT_ID", {
  email: "[e-mail]",
  personDetails: {
    firstName: "Jane",
    lastName: "Doe",
    dob: "1995-12-20",
    nationality: "US"
  }
});

Python

from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

client = cc_api.clients.update('CLIENT_ID',email='[e-mail]')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$updated = $ccapi->clients()->update($id, ['email' => '[e-mail]']);