Commet
  • Precios
Iniciar SesiónRegistrarse
Batch create customers POSTCreate customer POSTGet customer GETList customers GETUpdate customer PUT
DocumentaciónRecursosConstruir con AIAPI ReferenceWebhooks

Create customer

Create a new customer. Idempotent when customerId is provided.

POST
/customers

Create a new customer. Idempotent when customerId is provided.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string
externalId?string
fullName?string
address?
addressId?string
email*string
timezone*string
metadata*

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/customers" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "timezone": "UTC",    "metadata": {}  }'
{  "success": true,  "data": {    "id": "string",    "externalId": "string",    "fullName": "string",    "email": "string",    "timezone": "string",    "metadata": {      "property1": null,      "property2": null    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "object": "customer",    "livemode": true  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

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.