Skip to content

Confirm column mapping overrides for a matched segment

POST
/v1/segments/{id}/mappings
curl --request POST \
--url https://dev-api.infiniteaudience.ai/v1/segments/example/mappings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "column_mappings": { "additionalProperty": "example" } }'

Stores confirmed column mapping overrides for a matched-subtype segment. Call this after reviewing the POST /v1/match/{id}/analyze response to correct any incorrect predictions. Sets mapping_confirmed: true so the platform skips its own analysis and uses these mappings directly.

column_mappings may be omitted entirely — the platform then re-runs column analysis on the currently active upload itself and accepts its own suggested mapping as-is (the same behavior as reviewing POST /v1/match/{id}/analyze and confirming without edits, in one call). This can return 409 FILE_NOT_YET_UPLOADED if the file hasn’t finished uploading yet, or 422/400 on other analysis failures — pass column_mappings explicitly to skip re-analysis entirely.

If the segment was created or refreshed with hitl: true, the upload is still staged (not yet at the path that triggers automatic resolution) — this call also moves the staged file into place and starts identity resolution, which is why it can return 500 STAGING_COPY_FAILED if that move fails (the segment is left unchanged in that case; retry the call). Use POST /v1/segments/{id}/mappings/cancel instead to abort a staged upload without confirming. Requires ‘purchase’ scope.

id
required
string

Segment document ID.

Media typeapplication/json
object
column_mappings

Map of source column name → standard identity attribute name. Use "(skip)" as the value to explicitly exclude a column. Omit entirely (send {} or no body) to accept the platform’s own fresh column analysis of the active upload as-is.

object
key
additional properties
string
Examplegenerated
{
"column_mappings": {
"additionalProperty": "example"
}
}

Mappings saved.

Media typeapplication/json
object
ok
required
boolean
column_mappings
required
object
key
additional properties
string
Examplegenerated
{
"ok": true,
"column_mappings": {
"additionalProperty": "example"
}
}

Invalid request — malformed body, missing required attribute, or failed validation. See error and message for details.

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
Examplevalidation_error
{
"error": "Bad Request",
"code": "MISSING_SEGMENTS",
"message": "segment_ids is required for filter audiences."
}

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
{
"error": "Unauthorized: Missing or invalid Authorization header"
}

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
Examplemissing_scope
{
"error": "SCOPE_REQUIRED",
"message": "This endpoint requires the purchase scope."
}

Resource not found or not accessible to the calling org.

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
Examplenot_found
{
"error": "Audience not found"
}

Resource state conflicts with the request. For upload analysis this includes FILE_NOT_YET_UPLOADED.

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examplegenerated
{
"error": "example",
"message": "example",
"code": "example",
"request_id": "example"
}

Request is structurally valid but the resource is in a state that prevents the operation (e.g. expired, pending, or not yet uploaded). See error and code for the specific reason.

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
{
"error": "Audience expired",
"code": "AUDIENCE_EXPIRED",
"message": "This audience version expired. Run a refresh to create a new deliverable version."
}

STAGING_COPY_FAILED — moving a staged (hitl: true) upload into place failed; the segment is unchanged, retry the call. ANALYSIS_FAILED — column_mappings was omitted and re-analysis failed unexpectedly.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: STAGING_COPY_FAILED ANALYSIS_FAILED
message
required
string
Example
{
"code": "STAGING_COPY_FAILED"
}