API Reference

Update Client

patch
https://api.assembly.com/v1/clients/

This API endpoint updates a specific client.

This PATCH request will only update the fields you specify (including custom fields), leaving the rest as they were.

Please note that for multi-select (tag) custom fields, all custom field options (tag values) must be included, the PATCH request will not preserve existing custom field options (tags).

Path Params
string
required

The ID of the client to update

Query Params
boolean
Defaults to false

Sends an email invitation to the updated client.

Body Params
string

The client's given name.

string

The client's family name.

string

The ID of the company to assign this client to. This will replace the current companies that the client is assigned to.

json

The key is the custom field’s key, and the value is either an array of option keys (for multi-select fields) or a direct value for all other types. You can clear a field by passing an empty string (or empty array for multi-select); omitting the field leaves it unchanged.

Response

Updated 4 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago