URL Expired

The URL for this request expired after 30 days.

Notes: Skip link to Notes:

See notes on Create a Client for how to format customFields.

Coming soon: Support for multiple companies Skip link to Coming soon: Support for multiple companies

It is not currently possible to add companies to a client via this endpoint.

Currently, passing a companyIds array to add multiple companies to a client via this endpoint is not supported, but will not return an error.

companyId is supported, but will only replace the single existing company for the client, this is also noted on the request body below.

We're working on adding this functionality soon!

id

string

required

The ID of the client to update

sendInvite

boolean

Defaults to false

Sends an email invitation to the updated client.

truefalse

givenName

string

The client's given name.

familyName

string

The client's family name.

companyId

string

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

customFields

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.

``200 200

Updated8 months ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request PATCH \

--url 'https://api.assembly.com/v1/clients/id?sendInvite=false' \

--header 'accept: application/json' \

--header 'content-type: application/json'

Click `Try It!` to start a request and see the response here! Or choose an example:

application/json

``200 - Result

Updated8 months ago

* * *