Update

Update

Updates all properties of a customer.

Request

Method
URL
POST

Headers

Name
Required
Type
Description
APIKey
Guid
A valid API key with a scope of Customers | Update

Body

Property
Required
Type
Description
UniqueID
GUID
The unique ID of the customer.
ExternalID
Text
The external ID of the customer.
{
"ExternalID": "",
"UniqueID": "47222515-2eff-47bc-8cb7-1802653fadbd"
}
The rest of the properties are the same as when creating a customer with the Create endpoint.
Refer to the Create endpoint for an example of the body when updating a customer.

Remarks

Updated on 10/15/25, the ExternalID can now be used when updating a customer. Note, the ExternalID cannot be updated itself.
To identify a customer, only the UniqueID OR the ExternalID are used. If both are supplied, the UniqueID will be used.

Response

Headers

None

Status Code

Code
Description
200 OK
The customer was updated.
400 Bad Request
The customer was not updated. The reason why will be returned.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
404 Not Found
The customer was not found.

Body

All details, except the measure sheets and history, are returned. Refer to the body format when reading a customer for an explanation of the format.