Skip to main content
POST
/
entities
/
automatic
/
bulk
Bulk entity import (JSON)
curl --request POST \
  --url http://api.gu1.ai/entities/automatic/bulk \
  --header 'Authorization: Bearer <token>'

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

POST https://api.gu1.ai/entities/automatic/bulk

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

Authorization: Bearer YOUR_API_KEY

Import modes (importMode)

ModeDefaultBehavior
automatic_enrichedYes (when omitted)Basic data by tax ID for AR, BR, or CL + enrichments (autoExecuteIntegrations) + optional depth
manual_no_enrichmentNo (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
DefaultAutomaticManual
Manual + enrichmentsYes (autoExecuteIntegrations)Yes (autoExecuteIntegrations / per-row CSV columns)
InputJSON items[]CSV multipart

Body (summary)

FieldRequiredDescription
itemsYesRow array (taxId, type, …)
importModeNoautomatic_enriched (default) or manual_no_enrichment
countryConditionalBatch ISO2 when rows omit country
riskMatrixPersonId / riskMatrixCompanyIdNoUUID
autoExecuteIntegrationsNo{ executeAllActiveEnrichments, enrichments, enrichmentGroupRefs, excludeEnrichments }
autoExecuteIntegrationsShareholdersNoWhen depth > 0
depthNo0–5 (automatic mode)
skipRulesExecutionNodefault false
stopOnFirstErrorNodefault false
monitoringNo{ main, relationships? }
reportRecipientEmailsNoUp to 10 emails
emailLocaleNoen / es / pt

Per item (items[])

FieldDescription
taxId, typeRequired
countryOptional ISO2 per row
suggestedNameRequired in manual mode
gender, email, phone, externalId, attributes, status, riskMatrixId, …Optional
Supported countries: automatic β†’ AR, BR, CL; manual β†’ any valid platform ISO2 (batch and/or per row).

Limits

Value
Max items per requestDefault 300 (server env BULK_AUTOMATIC_ENTITY_MAX_ITEMS; not the plan table used for CSV)
Over limit400 TOO_MANY_ITEMS
For large CSV imports with plan-based limits (up to 100,000 rows), use Import entities (CSV) instead. See Bulk imports overview for the full limits matrix (transactions, entities CSV, user events).

Example β€” automatic

{
  "country": "AR",
  "importMode": "automatic_enriched",
  "autoExecuteIntegrations": {
    "executeAllActiveEnrichments": true,
    "enrichments": []
  },
  "items": [
    { "taxId": "20123456789", "type": "company" }
  ]
}

Example β€” manual with selected enrichments

{
  "country": "AR",
  "importMode": "manual_no_enrichment",
  "autoExecuteIntegrations": {
    "executeAllActiveEnrichments": false,
    "enrichments": ["some_enrichment_code"]
  },
  "items": [
    {
      "taxId": "20123456789",
      "type": "company",
      "suggestedName": "Demo Company SA"
    }
  ]
}

Response

{
  "success": true,
  "jobId": "bulk-entity-…",
  "totalItems": 1
}

Follow-up

  • GET /entities/automatic/bulk/imports
  • GET /entities/automatic/bulk/imports/{jobId}/failures.csv
See also: Bulk imports overview.