Updates a customer
Changed onUpdates a single customer record in the catalog. IMPORTANT: This is a full-replace operation (PUT semantics). All fields must be included in the request body — omitting any field will set it to null, wiping existing data. Always call retrieve-a-customer first to fetch the current record, then include ALL existing fields in your update request along with your changes. Exceptions that keep stored data when the field is omitted:
- metadata: omit it to keep all existing metadata, or send only the keys you want to set or clear.
- addresses: omit address and billing_addresses to keep the stored billing addresses, and likewise shipping_address and shipping_addresses. This is for backward compatibility: integrations built before customers could have several addresses won't wipe the ones they don't send.
Request
- Base URLhttps://api.rillet.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
UUID of the customer to be used in this operation.
Request body
Example request
{
"name": "Bob",
"name_on_invoice": "Bob Johnson",
"address": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Nashville",
"state": "TN",
"zip_code": "37201",
"country": "US"
},
"shipping_address": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Nashville",
"state": "TN",
"zip_code": "37201",
"country": "US"
},
"billing_addresses": [
{
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Nashville",
"state": "TN",
"zip_code": "37201",
"country": "US"
}
],
"shipping_addresses": [
{
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Nashville",
"state": "TN",
"zip_code": "37201",
"country": "US"
}
],
"emails": [
{
"id": "0193a6f2-4c1e-7b8a-9d3f-2e5c8a1b7f40",
"email": "bobjohnson@somedomain.com"
}
],
"external_references": [
{
"type": "xyzSystemId",
"id": "234",
"url": "https://xyzsystempage.com/ids/234"
}
],
"tax_ids": [
{
"value": "DE123456789"
}
]
}Response
OK
Example response
{
"name": "Bob",
"name_on_invoice": "Bob Johnson",
"address": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Nashville",
"state": "TN",
"zip_code": "37201",
"country": "US"
},
"shipping_address": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Nashville",
"state": "TN",
"zip_code": "37201",
"country": "US"
},
"billing_addresses": [
{
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Nashville",
"state": "TN",
"zip_code": "37201",
"country": "US"
}
],
"shipping_addresses": [
{
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Nashville",
"state": "TN",
"zip_code": "37201",
"country": "US"
}
],
"emails": [
{
"id": "0193a6f2-4c1e-7b8a-9d3f-2e5c8a1b7f40",
"email": "bobjohnson@somedomain.com"
}
],
"external_references": [
{
"type": "xyzSystemId",
"id": "234",
"url": "https://xyzsystempage.com/ids/234"
}
],
"tax_ids": [
{
"value": "DE123456789"
}
]
}Changes
- breaking
added
subschema #2to the request bodyallOflist - breaking
the request's body type changed from
objectto no type - breaking
the
////response's property type changed fromobjectto no type for status - breaking
the
////response's property type changed fromobjectto no type for status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the optional property
/////from the response with the status - warning
removed the optional property
/////from the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added to the
////response propertyallOflist for the response status - info
added to the
////response propertyallOflist for the response status - info
response property
allOf[CustomerRequest]/addressdeprecated - info
response property
allOf[CustomerRequest]/shipping_addressdeprecated
- breaking