Skip to main content
POST
/
customers
Create a customer
curl --request POST \
  --url https://api.kelviq.com/api/v1/customers/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "unique-customer-id-456",
  "email": "another.new.customer@example.com",
  "name": "Jane Roe",
  "metadata": {
    "source": "sdk_import",
    "priority": "low"
  },
  "billingAddress": {
    "country": "IN",
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "postalCode": "560001",
    "city": "Bangalore",
    "state": "Karnataka"
  }
}
'
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "customerId": "unique-customer-id-123",
  "name": "John Doe",
  "email": "new.customer@example.com",
  "details": {},
  "metadata": {
    "source": "sdk_import",
    "priority": "high"
  },
  "billingAddress": {
    "country": "IN",
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "postalCode": "560001",
    "city": "Bangalore",
    "state": "Karnataka"
  },
  "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'

Body

application/json
​
customerId
string
required

A unique identifier for the customer that you define.

Example:

"unique-customer-id-456"

​
email
string<email> | null

The email address of the customer.

Example:

"another.new.customer@example.com"

​
name
string | null

The name of the customer.

Example:

"Jane Roe"

​
metadata
object

A dictionary of custom key-value pairs.

Example:
{ "source": "sdk_import", "priority": "low" }
​
billingAddress
object

The billing address of the customer.

Response

201 - application/json

Customer Created

​
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:

"new.customer@example.com"

​
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"
}
​
billingAddress
object

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"