v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Configuration Field Maps

Update a field map

Use this endpoint to update the fields of a specific field map by its identifier.

patch/v1/field-maps/{fieldMapId}

Path parameters

fieldMapIdstring required

The unique identifier of the field map.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Request body

mappingobject

Response

Successfully updated field map.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

contextIdstring
createdAtstring
idstring
mappingobject
sourceIdstring
updatedAtstring
versioninteger