Skip to main content
PATCH
Update a field map

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency
string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409, and an idempotency storage failure returns 500. These refusals are problem documents.

Path Parameters

fieldMapId
string<uuid>
required

The unique identifier of the field map. Field map ID

Body

application/json

Field map updates

mapping
object
required

Field-mapping object that normalizes a source's raw columns to canonical transaction fields.

Response

Successfully updated field map.

contextId
string
required

Identifier of the context this field map belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

createdAt
string
required

Creation timestamp in RFC 3339 format.

Example:

"2025-01-15T10:30:00Z"

id
string
required

Unique identifier of the field map.

Example:

"550e8400-e29b-41d4-a716-446655440000"

mapping
object
required

Field-mapping object normalizing the source's raw columns to canonical transaction fields.

sourceId
string
required

Identifier of the source this field map normalizes.

Example:

"550e8400-e29b-41d4-a716-446655440000"

updatedAt
string
required

Last update timestamp in RFC 3339 format.

Example:

"2025-01-15T10:30:00Z"

version
integer<int64>
required

Monotonic mutation counter incremented server-side on each field-map change. Read-only on the write path and NOT honored for optimistic concurrency control.

Example:

1