cURL
curl --request POST \
--url https://commet.co/api/v1/customers/batch \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customers": [
{
"email": "jsmith@example.com",
"id": "<string>",
"externalId": "<string>",
"fullName": "<string>",
"taxDocument": "<string>",
"timezone": "UTC",
"metadata": {}
}
]
}
'import { Commet } from "@commet/node";
const commet = new Commet({ apiKey: "ck_xxx" });
const customerBatch = await commet.customers.createBatch({ customers: [{ email: "user@example.com" }] });from commet import Commet
commet = Commet("ck_xxx")
customer_batch = commet.customers.create_batch(customers=[{"email": "user@example.com"}])client, err := commet.New("ck_xxx")
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
customerBatch, err := client.Customers.CreateBatch(ctx, &commet.BatchCreateCustomersParams{
Customers: []commet.BatchCreateCustomersParamsCustomersItem{{
Email: "user@example.com",
}},
})
if err != nil {
log.Fatal(err)
}import co.commet.Commet;
import co.commet.models.BatchCreateCustomersParamsCustomersItem;
import co.commet.params.BatchCreateCustomersParams;
import java.util.List;
var commet = Commet.builder().apiKey("ck_xxx").build();
var customerBatch = commet.customers().createBatch(
BatchCreateCustomersParams.builder(List.of(new BatchCreateCustomersParamsCustomersItem("user@example.com", null, null, null, null, null, null, null))).build()
);use Commet\Commet;
$commet = new Commet('ck_xxx');
$customerBatch = $commet->customers->createBatch(
customers: [['email' => 'user@example.com']],
);{
"successful": [
{
"id": "cus_1a2b3c4d",
"externalId": null,
"email": "user@example.com"
}
],
"failed": [],
"object": "customer_batch",
"livemode": false
}{
"error": {
"type": "validation_error",
"code": "validation_error",
"message": "The request contains an invalid parameter.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"
}
}{
"error": {
"type": "authentication_error",
"code": "unauthorized",
"message": "A valid API key is required.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"
}
}{
"error": {
"type": "authentication_error",
"code": "forbidden",
"message": "You do not have permission to perform this operation.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"
}
}{
"error": {
"type": "conflict_error",
"code": "idempotency_in_progress",
"message": "A request with this idempotency key is still being processed.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Too many requests. Retry after the interval specified in the Retry-After header.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"
}
}{
"error": {
"type": "internal_error",
"code": "internal_error",
"message": "An unexpected error occurred while processing the request.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"
}
}{
"error": {
"type": "internal_error",
"code": "idempotency_unavailable",
"message": "Idempotency storage is temporarily unavailable. Retry with the same idempotency key.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md"
}
}Customers
Batch create customers
Create up to 100 customers in a single request.
POST
/
customers
/
batch
cURL
curl --request POST \
--url https://commet.co/api/v1/customers/batch \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customers": [
{
"email": "jsmith@example.com",
"id": "<string>",
"externalId": "<string>",
"fullName": "<string>",
"taxDocument": "<string>",
"timezone": "UTC",
"metadata": {}
}
]
}
'import { Commet } from "@commet/node";
const commet = new Commet({ apiKey: "ck_xxx" });
const customerBatch = await commet.customers.createBatch({ customers: [{ email: "user@example.com" }] });from commet import Commet
commet = Commet("ck_xxx")
customer_batch = commet.customers.create_batch(customers=[{"email": "user@example.com"}])client, err := commet.New("ck_xxx")
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
customerBatch, err := client.Customers.CreateBatch(ctx, &commet.BatchCreateCustomersParams{
Customers: []commet.BatchCreateCustomersParamsCustomersItem{{
Email: "user@example.com",
}},
})
if err != nil {
log.Fatal(err)
}import co.commet.Commet;
import co.commet.models.BatchCreateCustomersParamsCustomersItem;
import co.commet.params.BatchCreateCustomersParams;
import java.util.List;
var commet = Commet.builder().apiKey("ck_xxx").build();
var customerBatch = commet.customers().createBatch(
BatchCreateCustomersParams.builder(List.of(new BatchCreateCustomersParamsCustomersItem("user@example.com", null, null, null, null, null, null, null))).build()
);use Commet\Commet;
$commet = new Commet('ck_xxx');
$customerBatch = $commet->customers->createBatch(
customers: [['email' => 'user@example.com']],
);{
"successful": [
{
"id": "cus_1a2b3c4d",
"externalId": null,
"email": "user@example.com"
}
],
"failed": [],
"object": "customer_batch",
"livemode": false
}{
"error": {
"type": "validation_error",
"code": "validation_error",
"message": "The request contains an invalid parameter.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"
}
}{
"error": {
"type": "authentication_error",
"code": "unauthorized",
"message": "A valid API key is required.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"
}
}{
"error": {
"type": "authentication_error",
"code": "forbidden",
"message": "You do not have permission to perform this operation.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"
}
}{
"error": {
"type": "conflict_error",
"code": "idempotency_in_progress",
"message": "A request with this idempotency key is still being processed.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Too many requests. Retry after the interval specified in the Retry-After header.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"
}
}{
"error": {
"type": "internal_error",
"code": "internal_error",
"message": "An unexpected error occurred while processing the request.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"
}
}{
"error": {
"type": "internal_error",
"code": "idempotency_unavailable",
"message": "Idempotency storage is temporarily unavailable. Retry with the same idempotency key.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md"
}
}Create up to 100 customers in a single request.
Autorizaciones
Encabezados
Unique key used to safely retry this write for 24 hours without applying it twice.
Required string length:
1 - 200API version used by this reference. Send this header to select this contract explicitly.
Cuerpo
application/json
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
¿Esta página le ayudó?