Bulk entity import (JSON)
API Reference
Bulk entity import (JSON)
Enqueue bulk entity import with a JSON body β same job as the Entities hub. Automatic by default; manual with selectable enrichments.
POST
Bulk entity import (JSON)
Documentation Index
Fetch the complete documentation index at: https://docs.gu1.ai/llms.txt
Use this file to discover all available pages before exploring further.
Endpoint
Overview
Content-Type:application/json.
Used by the Bulk imports β Entities hub (/bulk-imports?tab=entities) and integrations that already parsed rows to JSON. Enqueues the same job as Import entities (CSV).
Requires entities:bulk_import, entities:create, and org bulk automatic entity import enabled.
Authentication
Import modes (importMode)
| Mode | Default | Behavior |
|---|---|---|
automatic_enriched | Yes (when omitted) | Basic data by tax ID for AR, BR, or CL + enrichments (autoExecuteIntegrations) + optional depth |
manual_no_enrichment | No (explicit) | Minimal entity; suggestedName required on every item; selected enrichments via autoExecuteIntegrations (no basic-data pipeline); depth = 0; any valid platform ISO2 |
vs multipart CSV
| This endpoint (JSON) | POST /batch-import/import/entities | |
|---|---|---|
| Default | Automatic | Manual |
| Manual + enrichments | Yes (autoExecuteIntegrations) | Yes (autoExecuteIntegrations / per-row CSV columns) |
| Input | JSON items[] | CSV multipart |
Body (summary)
| Field | Required | Description |
|---|---|---|
items | Yes | Row array (taxId, type, β¦) |
importMode | No | automatic_enriched (default) or manual_no_enrichment |
country | Conditional | Batch ISO2 when rows omit country |
riskMatrixPersonId / riskMatrixCompanyId | No | UUID |
autoExecuteIntegrations | No | { executeAllActiveEnrichments, enrichments, enrichmentGroupRefs, excludeEnrichments } |
autoExecuteIntegrationsShareholders | No | When depth > 0 |
depth | No | 0β5 (automatic mode) |
skipRulesExecution | No | default false |
stopOnFirstError | No | default false |
monitoring | No | { main, relationships? } |
reportRecipientEmails | No | Up to 10 emails |
emailLocale | No | en / es / pt |
Per item (items[])
| Field | Description |
|---|---|
taxId, type | Required |
country | Optional ISO2 per row |
suggestedName | Required in manual mode |
gender, email, phone, externalId, attributes, status, riskMatrixId, β¦ | Optional |
Limits
| Value | |
|---|---|
Max items per request | Default 300 (server env BULK_AUTOMATIC_ENTITY_MAX_ITEMS; not the plan table used for CSV) |
| Over limit | 400 TOO_MANY_ITEMS |
Example β automatic
Example β manual with selected enrichments
Response
Follow-up
GET /entities/automatic/bulk/importsGET /entities/automatic/bulk/imports/{jobId}/failures.csv