<- Customers API

Customers API

Bulk create customers



This endpoint takes a map of individual create requests and returns a map of responses.

You must provide at least one of the following values in each create request:

  • given_name
  • family_name
  • company_name
  • email_address
  • phone_number
Try in API Explorer
Link to section

Request body

Example code

Link to section



A map of 1 to 100 individual create requests, represented by idempotency key: { customer data } key-value pairs.

Each key is an idempotency key that uniquely identifies the create request. Each value contains the customer data used to create the customer profile.

Link to section

Response fields

Link to section


A map of responses that correspond to individual create requests, represented by key-value pairs.

Each key is the idempotency key that was provided for a create request and each value is the corresponding response. If the request succeeds, the value is the new customer profile. If the request fails, the value contains any errors that occurred during the request.

Link to section


Any top-level errors that prevented the bulk operation from running.