SupDesk
PATCH/v1/customers/{id}

Update a customer or link its identity

Updates a customer's name or identity link. Set primary_customer_id to link this customer to another customer, or to null to unlink it; the server validates identity links.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
idstringrequired
The unique identifier of the customer to update.

The customer fields to update; both fields are optional.

namestringoptional
The customer's name.
primary_customer_idstringoptional
The identifier of another customer to link as the same person, or `null` to unlink this customer.

4 status codes
200Returns the updated customer in the `data` object.
dataobjectoptional
400Returned when an identity link fails validation, including a self-link, cross-project link, or chained link.
errorobjectoptional
401Returned when the request is unauthenticated or authentication is invalid.
errorobjectoptional
404Returned when no customer exists with the given `id`.
errorobjectoptional

Error handling

A 400 is returned when primary_customer_id creates a self-link, cross-project link, or chained link. A 401 is returned when the request lacks valid authentication. A 404 is returned when the id path parameter does not identify an existing customer.