Skip to main content
PATCH
Patch a Matter

Authorizations

Authorization
string
header
required

Environment-specific Integration key. Never paste a live key into documentation tooling.

Headers

If-Match
string

The entity-tag the write is conditioned on, from the ETag header or the etag field of the representation you last read. Required to update an existing Matter. A stale tag returns 412; omitting it on an update returns 428. * matches any current Matter and returns 412 when none exists. A closed Matter returns 409 matter_closed until it is reopened.

Example:

"\"m1-7f3a9c2b\""

Path Parameters

clientCode
string
required

Granted Local Authority Client code

Pattern: ^[A-Z][A-Z0-9]{1,31}$
Example:

"SDCC"

clientReferenceId
string
required

Stable partner Matter key; must not contain personal data 1-128 characters; . and .. alone are refused.

Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._-]{1,128}$
Example:

"SDCC-2026-00482"

Body

application/merge-patch+json
clientCode
string
Pattern: ^[A-Z][A-Z0-9]{1,31}$
Example:

"SDCC"

clientReferenceId
string

1-128 characters; . and .. alone are refused.

Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._-]{1,128}$
Example:

"SDCC-2026-00482"

matterType
enum<string>
default:debt_recovery

The kind of legal work instructed. Optional on write; omitted means debt_recovery. Always returned.

Available options:
debt_recovery
parties
(Person party · object | Organisation party · object)[]

Replaces the entire Matter Party collection. JSON Merge Patch replaces arrays wholesale, so every entry must be complete — including addresses, emails and phones — and exactly one entry must set isPrimaryLiable: true. There is no partial patch of a single Party, and null is not accepted: a Matter always has at least one liable Party.

Required array length: 1 - 10 elements

One Matter Party: a Party's participation in this Matter through a Matter-specific role. Several Parties may hold the debtor role on one Matter; joint liability never multiplies the obligation, so debt.outstandingAmount remains the single Matter total.

debt
object

Present so that a PATCH naming money is parsed and refused by the money rules rather than rejected as an unknown field. A debt member that would change currency or outstandingAmount returns 409 opening_balance_change_not_allowed without mutation, whether or not the recovery activity marker is set. A debt member identical to the current authoritative values is a no-op under the ordinary identical-content rule. type may change; null removes it.

instruction
object | null

Response

Current partner-facing Matter representation

clientCode
string
required
Pattern: ^[A-Z][A-Z0-9]{1,31}$
Example:

"SDCC"

clientReferenceId
string
required

1-128 characters; . and .. alone are refused.

Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._-]{1,128}$
Example:

"SDCC-2026-00482"

matterType
enum<string>
default:debt_recovery
required

The kind of legal work instructed. Optional on write; omitted means debt_recovery. Always returned.

Available options:
debt_recovery
parties
(Person party · object | Organisation party · object)[]
required
Required array length: 1 - 10 elements

One Matter Party: a Party's participation in this Matter through a Matter-specific role. Several Parties may hold the debtor role on one Matter; joint liability never multiplies the obligation, so debt.outstandingAmount remains the single Matter total.

debt
object
required
instruction
object
required
matterId
string
required
sourceRevisionId
string
required
lifecycleStateId
string
required
etag
string
required

Strong entity-tag of this partner-facing representation, identical to the ETag response header. Send it back as If-Match on the next write.

Example:

"\"m1-7f3a9c2b\""

status
enum<string>
required
Available options:
received,
in_review,
active,
paused,
closed
intakeStatus
enum<string>
required
Available options:
needs_review,
ready
createdAt
string<date-time>
required
updatedAt
string<date-time>
required