Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Configuration Match Rules

Update a match rule

Use this endpoint to update the fields of a specific match rule by its identifier.

patch/v1/contexts/{contextId}/rules/{ruleId}

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

ruleIdstring required

The unique identifier of the match rule.

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

configobject
priorityinteger
type'EXACT' | 'TOLERANCE' | 'DATE_LAG'

Type of matching rule algorithm

Example request

{
  "priority": 2
}

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.

configobject

Rule configuration

contextIdstring

Context ID this rule belongs to

createdAtstring

Creation timestamp in RFC3339 format

idstring

Unique identifier for the rule

priorityinteger

Execution priority (lower = higher priority)

type'EXACT' | 'TOLERANCE' | 'DATE_LAG'

Type of matching rule

updatedAtstring

Last update timestamp in RFC3339 format

Example response

{
  "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"
}