(PUT) Update customers
Update existing customers by ID or external ID.
Endpoint
PUT /api/customers
Update one or more existing customers in a single request. Entries with id update that customer. Entries without id use externalId to find an existing active customer. This endpoint does not create customers.
Endpoint text
PUT /api/customersAuthentication
Requires authentication with an API key that has the customersWrite scope.
Request Body
The request body must be an array of customer objects.
| Parameter | Type | Required | Description |
|---|---|---|---|
id (body) | string (UUID) | No | Existing customer ID. When provided, the entry updates that customer. |
externalId (body) | string | No | External customer identifier. Without `id`, this identifies the existing customer to update. With `id`, it can update the customer's external ID. |
name (body) | string/null | No | Customer display name. Send null to clear. |
email (body) | string/null | No | Customer email address. Send null to clear. |
phone (body) | string/null | No | Customer phone number. Send null to clear. |
avatar (body) | string/null | No | HTTPS avatar image URL. Send null to clear. |
Entries with id must include at least one mutable field. Entries without id must include externalId for an existing customer and at least one customer field (name, email, phone, or avatar).