Skip to main content
PATCH
Update a lien

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Path Parameters

lienId
string
required

Lien id

Query Parameters

organizationId
string<uuid>

Select one organization for this request. Defaults to the key organization. An HQ key may select an active descendant when its active acting attorney has the required HQ and resource permissions. Repeat the same organizationId on related mutations, upload completion, detail requests, and every cursor page. See /authorization.

Body

application/json
holderName
string
Required string length: 1 - 500
holderContactId
string | null
Required string length: 1 - 200
amountCents
integer
Required range: x <= 100000000000
interestRate
number | null
Required range: 0 <= x <= 1000
interestType
enum<string> | null
Available options:
Simple,
Compound,
null
accrualFrequency
enum<string> | null
Available options:
Monthly,
Quarterly,
Annually,
null
startDate
string
reductionCents
integer | null
Required range: 0 <= x <= 100000000000
reductionStatus
enum<string> | null
Available options:
Pending,
Approved,
Rejected,
null
notes
string | null
Maximum string length: 5000

Response

{ success: true, lien }

success
boolean
required
{key}
any