Map sheet columns

post

https://api.oneschema.co/v1/sheets/{sheet_id}/mapping

Map the sheet columns to template columns and trigger validation for the mapped columns.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sheet_id

int32

required

The id of the sheet.

Query Params

embed_id

int32

The id of the embed which contains the sheet.

Body Params

overrides

array of objects

These mappings will override mappings created automatically. Either column_id or column_name must be specified. If template_column_key is null, the sheet column will not be mapped.

overrides

autofix

boolean

Defaults to false

Whether to autofix errors after the mapping step. This is akin to clicking the "Fix all formatting errors" button.

strategies

array of strings

Defaults to exact,hint

Which mapping strategies to use in which order. Values are exact, hint (Alternative column names for mapping), fuzzy, historical_user, and historical_org. If historical_user and historical_org should be used it's preferred to provide historical instead.

strategies

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response. The primary way to verify the request's success or failure is the response status code. In a future API version this endpoint may not return any response body at all.

400400