Skip to main content
PATCH
/
v1
/
contexts
/
{contextId}
/
rules
/
{ruleId}
Update a match rule
curl --request PATCH \
  --url https://matcher.sandbox.lerian.net/v1/contexts/{contextId}/rules/{ruleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {},
  "priority": 2,
  "type": "TOLERANCE"
}
'
{
  "config": {},
  "contextId": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "id": "019c96a0-1071-7a0d-9916-a831221de252",
  "priority": 1,
  "type": "EXACT",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

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.

Matching rule within a reconciliation context

​
config
object

Rule configuration

​
contextId
string

Context ID this rule belongs to

Example:

"019c96a0-10a0-72d2-9fb0-2b7de8093182"

​
createdAt
string

Creation timestamp in RFC3339 format

Example:

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

​
id
string

Unique identifier for the rule

Example:

"019c96a0-1071-7a0d-9916-a831221de252"

​
priority
integer

Execution priority (lower = higher priority)

Required range: 1 <= x <= 1000
Example:

1

​
type
enum<string>

Type of matching rule

Available options:
EXACT,
TOLERANCE,
DATE_LAG
Example:

"EXACT"

​
updatedAt
string

Last update timestamp in RFC3339 format

Example:

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