Skip to main content
POST
Create 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'

Body

application/json
customerId
string
required

A stable identifier for this customer record. You define this value, and it must be unique within your Kelviq organization.

Example:

"unique-customer-id-456"

email
string<email> | null

The customer's email address. Email addresses do not have to be unique. More than one customer record can use the same email if each record has a different customerId.

Example:

"another.new.customer@example.com"

name
string | null

The name of the customer.

Example:

"Jane Roe"

metadata
object | null

A dictionary of custom key-value pairs.

Example:
billingAddress
object | null

The billing address of the customer.

Response

201 - application/json

Customer Created

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"