Skip to main content
POST
/
api
/
v1
/
customers
/
import
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1.customers.import({
  customers: [
    {
      id: 'id',
      email: 'dev@stainless.com',
      name: 'name',
    },
  ],
});

console.log(response.data);
{
  "data": {
    "newCustomers": [
      "customer-6e24b4",
      "customer-8f35c7"
    ]
  }
}

Authorizations

​
X-API-KEY
string
header
required

Server API Key

Headers

​
X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

​
X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Body

application/json

Bulk import up to 1000 customers. Existing customers are updated, new ones are created.

​
customers
object[]
required

List of customer objects to import

Required array length: 1 - 1000 elements
​
integrationId
string

Integration details

Maximum string length: 255

Response

Import results with success and failure details.

Response object

​
data
ImportCustomersResult · object
required

List of newly created customer IDs from the import operation.