Update a Client (destructive)

put https://api.copilot.com/v1/clients/{id}

This API endpoint updates a specific client.

This PUT request will perform a destructive update and clear all unspecified field values, including custom fields.

Notes:

companyId

If this field is left empty, the client will be removed from their existing company and a placeholder ID will be assigned. See the Company resource for more information on placeholder companies.

Custom Fields

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

Language

Authorization

Header

Click Try It! to start a request and see the response here!