Skip to main content
POST
/
api
/
v1
/
customers
/
bulk-create
cURL
curl -X POST https://api.metrifox.com/api/v1/customers/bulk-create \
  -H "x-api-key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "customers": [
      {
        "customer_type": "BUSINESS",
        "customer_key": "acme_corp_001",
        "primary_email": "contact@acmecorp.com",
        "legal_name": "Acme Corporation",
        "display_name": "Acme Corp"
      },
      {
        "customer_type": "INDIVIDUAL",
        "customer_key": "jane_doe_001",
        "primary_email": "jane@example.com",
        "first_name": "Jane",
        "last_name": "Doe"
      }
    ]
  }'
{
  "statusCode": 200,
  "message": "Bulk Customer Creation Completed",
  "meta": {},
  "data": {
    "total": 3,
    "successful_count": 3,
    "failed_count": 0,
    "customers_created": [
      {
        "index": 0,
        "customer_key": "acme_corp_001",
        "data": {
          "id": "764c80e3-ed59-44a5-ba07-7ee5ba547774",
          "customer_type": "BUSINESS",
          "primary_email": "contact@acmecorp.com",
          "display_name": "Acme Corp"
        }
      },
      {
        "index": 1,
        "customer_key": "jane_doe_001",
        "data": {
          "id": "864c80e3-ed59-44a5-ba07-7ee5ba547775",
          "customer_type": "INDIVIDUAL",
          "primary_email": "jane@example.com",
          "display_name": "Jane Doe"
        }
      },
      {
        "index": 2,
        "customer_key": "globex_001",
        "data": {
          "id": "964c80e3-ed59-44a5-ba07-7ee5ba547776",
          "customer_type": "BUSINESS",
          "primary_email": "info@globex.com",
          "display_name": "Globex"
        }
      }
    ],
    "customers_failed": []
  },
  "errors": {}
}
Each customer is processed independently. If some customers fail (e.g., duplicate email or customer key), the others will still be created. Check both customers_created and customers_failed arrays in the response to handle partial failures.
A maximum of 100 customers can be created per request. Each customer accepts the same fields as the single create endpoint.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
customers
object[]
required

Array of customer objects to create (max 100)

Maximum array length: 100

Response

Bulk creation completed (may include partial failures)

​
statusCode
integer
Example:

200

​
message
string
Example:

"Bulk Customer Creation Completed"

​
data
object
​
errors
object