Skip to main content
PATCH
/
v1
/
config
/
field-maps
/
{fieldMapId}
Update a field map
curl --request PATCH \
  --url https://matcher.sandbox.lerian.net/v1/config/field-maps/{fieldMapId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "mapping": {}
}'
{
  "contextId": "<string>",
  "createdAt": "<string>",
  "id": "<string>",
  "mapping": {},
  "sourceId": "<string>",
  "updatedAt": "<string>",
  "version": 123
}

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-Key
string

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.

Path Parameters

​
fieldMapId
string
required

The unique identifier of the field map.

Body

application/json

Field map updates

​
mapping
object

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.

​
contextId
string
​
createdAt
string
​
id
string
​
mapping
object
​
sourceId
string
​
updatedAt
string
​
version
integer