Skip to main content
PATCH
/
customers
/
{customerId}
Update a customer
curl --request PATCH \
  --url https://api.kelviq.com/api/v1/customers/{customerId}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "name": "Johnathan Doe",
  "metadata": {
    "source": "sdk_import",
    "priority": "very_high",
    "status": "active"
  }
}
'
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "customerId": "unique-customer-id-123",
  "name": "Johnathan Doe",
  "email": "[email protected]",
  "details": {},
  "metadata": {
    "source": "sdk_import",
    "priority": "high",
    "status": "active"
  },
  "createdOn": "2025-06-04T06:03:30.195790Z",
  "modifiedOn": "2025-06-04T06:03:30.195831Z"
}

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:

"[email protected]"

​
name
string | null

The name of the customer.

Example:

"Johnathan Doe"

​
metadata
object

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

Example:
{
  "source": "sdk_import",
  "priority": "very_high",
  "status": "active"
}

Response

200 - application/json

Customer Updated

​
id
string<uuid>

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:

"[email protected]"

​
details
object

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

Example:
{}
​
metadata
object

The metadata associated with the customer.

Example:
{
  "source": "sdk_import",
  "priority": "high"
}
​
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"