Skip to main content
PATCH
/
v1
/
config
/
contexts
/
{contextId}
/
rules
/
{ruleId}
Update a match rule
curl --request PATCH \
  --url https://matcher.sandbox.lerian.net/v1/config/contexts/{contextId}/rules/{ruleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {},
  "priority": 2,
  "type": "TOLERANCE"
}
'
{
  "config": {},
  "contextId": "<string>",
  "createdAt": "<string>",
  "id": "<string>",
  "priority": 123,
  "type": "EXACT",
  "updatedAt": "<string>"
}

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

​
contextId
string
required

The unique identifier of the reconciliation context.

​
ruleId
string
required

The unique identifier of the match rule.

Body

application/json

Match rule updates

​
config
object
​
priority
integer
Required range: 1 <= x <= 1000
Example:

2

​
type
enum<string>

Type of matching rule algorithm

Available options:
EXACT,
TOLERANCE,
DATE_LAG
Example:

"TOLERANCE"

Response

Successfully updated match rule.

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.

​
config
object
​
contextId
string
​
createdAt
string
​
id
string
​
priority
integer
​
type
enum<string>

Type of matching rule algorithm

Available options:
EXACT,
TOLERANCE,
DATE_LAG
​
updatedAt
string