Skip to main content

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.

Overview

Bulk imports let you upload CSV files mapped to Güeno fields using saved mappings (mappingId). The dashboard hub (Bulk imports) uses the same API routes as integrations. Base path: all routes below are prefixed with /batch-import (for example GET https://api.gu1.ai/batch-import/mappings).

Authentication

Use the same Bearer API key or session as the rest of the API. Requests are organization-scoped; mappingId values belong to the current organization only.

Naming: mappingId (not mapperId)

Multipart imports expect the form field mappingId, the UUID returned when you list or create mappings (GET / POST /batch-import/mappings). There is no mapperId field.

“Platform” vs custom CSV

There is no single type: custom | platform parameter. Behavior depends on the route and whether you send a mapping:
ScenarioHow it works
Transactions — native file formatPOST /transactions/batch/upload without mappingId or columnMapping: server parses CSV / Excel / JSON with the built-in parser. See Create batch transactions.
Transactions — saved mappingSame upload endpoint with mappingId, or columnMapping as a JSON string (CSV only). Also available as POST /batch-import/import/transactions.
Entities — dashboard “Entities” tabPOST /entities/automatic/bulk with a JSON body (items[]); CSV is parsed in the client, not sent as raw multipart CSV to that route.
Entities — arbitrary CSV columnsPOST /batch-import/import/entities with file + mappingId (mapping target must be entity_person, entity_company, or entity_mixed). Requires bulk automatic entity import to be enabled for the org.
User eventsPOST /batch-import/import/user-events with file + mappingId (target user_event).
  • Endpoints overview — table of all routes; each endpoint below has its own page with the GET/POST badge in the sidebar (same pattern as the rest of the API docs).
  • Create batch transactions — multipart upload and limits for transaction files.