Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

migration
string
required

The ID of the migration whose columns get suggestions.

entity
string
required

The entity whose columns get suggestions, such as items or boms.

Body

application/json

Asks the AI column mapper to suggest target fields for one entity.

include_samples
boolean

Whether to send the sample values of columns that look like people's details unmasked. Once true, it stays on for this migration, and the choice is recorded in the audit log. Defaults to false.

Response

MigrationResource

data
MigrationResource · object
required

A migration: one move of records into the organization from CSV files or a connection, with its status and check report. Its entities are listed only when one migration is shown.