Skip to main content
POST
Check Mapping
← Imports Ask which template columns a mapping still needs before the mapping step can go on, without saving anything and without reading the file’s rows. Call it whenever the person changes the mapping or a fixed value, and let them continue once unmapped_required is empty. It is the same answer Suggest Mapping and Confirm Mapping return in unmapped_required, and the same rule automatic imports stop on, so a client never keeps its own copy of it. A column is listed when:
  • the template requires it (requirement.must_assign in Get a template) and it has no source column, no fixed value and no template default. A default taken from another column ({"from_column": "start_date"}) counts while that column has a value, as far down the chain as it goes. A value the page the file was uploaded from fills or fixes counts too.
  • another mapped column asks for it (requirement.must_assign_with): a wastes file that maps each row’s company needs a facility column. A fixed value does not answer it, since the rows name it one by one.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

string
required
UUID of the import sessionExample: "11111111-1111-1111-1111-111111111111"

Body Parameters

object
required
The draft mapping, {target_column: source_column | null}. Keys that are not template columns are ignored, and source columns are not checked against the file (the confirm does that).Example: {"check_in_date": "Check in", "country": null}
object
The draft fixed values, {target_column: value}. Blank values do not count.Example: {"country": "ES"}

Response

array[string]
The template columns the mapping still needs, in the template’s order: first the required ones with nothing, then those another mapped column asks for. Empty when the mapping step can go on.

Example

Successful Response

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

404 Not Found

Cause: The import session does not exist or belongs to another organization. Both cases return the same response.

Suggest Mapping

Suggested mapping, with what it still lacks

Confirm Mapping

Persist the chosen mapping