Skip to main content
PATCH
Update a customer
Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

customerId
string
required

The client-defined unique identifier for the customer.

Body

application/json

Fields for updating an existing customer. Only provided fields will be updated.

email
string<email> | null

The email address of the customer.

Example:

"jane.roe.updated@example.com"

name
string | null

The name of the customer.

Example:

"Johnathan Doe"

metadata
object | null

A dictionary of custom key-value pairs. If provided, it typically replaces the existing metadata. Refer to API behavior for merge strategy.

Example:
billingAddress
object | null

The billing address of the customer.

Response

200 - application/json

Customer Updated

id
string<uuid>
read-only

Server-generated unique UUID for the customer record.

Example:

"a1b2c3d4-e5f6-7890-1234-567890abcdef"

customerId
string

The client-provided customer identifier.

Example:

"unique-customer-id-123"

name
string | null

The customer's name.

Example:

"John Doe"

email
string<email> | null

The customer's email.

Example:

"new.customer@example.com"

details
object
read-only

Any server-added details about the customer (typically read-only).

Example:
metadata
object | null

The metadata associated with the customer.

Example:
billingAddress
object | null

The billing address of the customer.

createdOn
string

Customer created date and time

Example:

"2025-06-04T06:03:30.195790Z"

modifiedOn
string

Customer updated date and time

Example:

"2025-06-04T06:03:30.195790Z"