Skip to main content
POST
Create Entity Field Mapping

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ingestionConfigId
string

The ingestion config that provides the source data (required). The mapping binds to this config's most recently discovered external schema; a sync must have run first (otherwise NOT_FOUND).

internalFieldId
string

The internal entity-type field to populate (required).

externalFieldPath
string

Dot-notation path into the external record, e.g. "general.platform" (required). Read the available paths via GetExternalEntitySchema.

priority
number<double> | null

Precedence when multiple sources map to the same internal field (higher wins). Defaults to 1.0.

Response

200 - application/json

Success

data
data · object

The created field mapping.