Bulk import contacts

Creates or updates contacts in bulk from a list, returning per-entry results with created, updated, skipped, and error counts.

POST
/v1/contacts/bulk-import

Creates or updates contacts in bulk from a list, returning per-entry results with created, updated, skipped, and error counts.

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

contacts*array<>
upsertByEmail?boolean|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/contacts/bulk-import" \  -H "Content-Type: application/json" \  -d '{    "contacts": [      {        "name": "string"      }    ]  }'
{  "total": 0,  "created": 0,  "updated": 0,  "skipped": 0,  "errors": 0,  "results": [    {      "index": 0,      "status": "created",      "contactId": "string",      "error": "string"    }  ]}

Related documentation