Sign in

v47

OpenAPI 3.0.0raw.githubusercontent.com2026-08-013871777.1 KB
Customer

Update a Customer

Update the Customer details

post/api/service/customer/update

Headers

Idempotency-Keystring

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

idstring required

The id of the customer

emailstring nullable

The email address of the customer

phonestring nullable

The phone number of the customer in international format (e.g., +491631234567)

fullNamestring nullable

The full name or business name of the customer

dateOfBirthstring nullable

Customer's date of birth in ISO 8601 datetime format. Example: '2025-09-05'. Reference: https://en.wikipedia.org/wiki/ISO_8601

metadataobject

A collection of key-value pairs that can be associated with an object to store custom data in a structured manner. This allows you to attach arbitrary information to enhance the object with additional context or properties. To clear the metadata, send an empty object.

Response

Successful response

idstring required

The id of the customer

emailstring

The email address of the customer

emailAddressstring

Deprecated. Use the customer.email instead

phonestring

The phone number of the customer

fullNamestring

The full name or business name of the customer

dateOfBirthstring

Customer's date of birth in ISO 8601 datetime format. Example: '2025-09-05'. Reference: https://en.wikipedia.org/wiki/ISO_8601

deletedboolean

Indicates whether the customer was deleted

deletedAtstring date-time

The customer deletion timestamp

metadataobject

A collection of key-value pairs that can be associated with an object to store custom data in a structured manner. This allows you to attach arbitrary information to enhance the object with additional context or properties. To clear the metadata, send an empty object.