Commet
  • Pricing
Log InTry out
Batch create customers POSTCreate customer POSTGet customer GETList customers GETUpdate customer PUT
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Create customer

Create a new customer. Idempotent when externalId is provided.

Batch create customers POST

Create up to 100 customers in a single request.

Get customer GET

Retrieve a customer by their public ID, including subscription status and metadata.

POST
/customers

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string
Lengthlength <= 100
externalId?string
Lengthlength <= 100
fullName?string
Lengthlength <= 200
address?
addressId?string
Formatuuid
billingEmail*string
email
length <= 200
timezone?string
"UTC"
"UTC" | "America/New_York" | "America/Chicago" | "America/Denver" | "America/Los_Angeles" | "America/Sao_Paulo" | "America/Mexico_City" | "America/Buenos_Aires" | "America/Santiago" | "America/Bogota" | "America/Lima" | "America/Asuncion" | "Europe/London" | "Europe/Paris" | "Europe/Berlin" | "Europe/Madrid" | "Asia/Tokyo" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Dubai" | "Australia/Sydney"
metadata?
{}
isActive?boolean
true

Response Body

application/json

application/json

curl -X POST "https://commet.co/api/customers" \  -H "Content-Type: application/json" \  -d '{    "billingEmail": "user@example.com"  }'
Format
Length
Default
Value in
Default
Default

application/json

application/json

Your user ID — used to identify this customer in all SDK methods

Create a new customer. Idempotent when externalId is provided.

{
  "success": true,
  "data": {
    "id": "string",
    "organizationId": "string",
    "externalId": "string",
    "fullName": "string"
  }
}
{
  "success": true,
  "data": {
    "id": "string",
    "externalId": "string",
    "fullName": "string",
    "billingEmail": "string",
    "timezone": "string",
    "metadata": {
      "property1": null,
      "property2": null






{
  "success": false,
  "code": "string",
  "message": "string",
  "details": null
}
{
  "success": false,
  "code": "string",
  "message": "string",
  "details": null
}
},
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}