Update a client

URL

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.

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.

Path parameters

Name	Type	Description
id*	string	The ID of the client.

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. Also, see the person details object below.
companyDetails	object	Primary details for a client of type company. This is required when the type is company. Also, see the company details object below.
metadata	object	Set of key-value pairs that you can associate with the client object. This is useful for storing additional information about the client in a structured format. You can specify up to 20 keys, with key names up to 40 characters long and values up to 500 characters long.

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": "[email protected]",
		"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: "[email protected]",
  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='[email protected]')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$updated = $ccapi->clients()->update($id, ['email' => '[email protected]']);

.NET

using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;

var clientApi = new ClientApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var update = new ClientRequest {
  email: "[email protected]",
  personDetails = new PersonDetails {
    firstName = "Jane",
    lastName = "Doe"
  }
};

var client = await clientApi.UpdateAsync("CLIENT_ID", update);

Example response

Success (200)

{
    "id": "5eb04fcd0f3e360008035eb1",
    "type": "person",
    "email": "[email protected]",
    "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"
}