Update an existing chattel document

PATCH /v1/documents/:id lets you update the metadata of a document you own. All body fields are optional; you only need to include the fields you want to change. Successfully updating a document triggers a document.updated event in your activity feed.

This endpoint updates document metadata only. To attach or modify the associated loan, use the create endpoint with a new document, or contact support for loan record changes.

PATCH /v1/documents/:id

Request headers

string

required

Bearer token obtained from your Clerk session. Example: Bearer eyJhbGc...

string

required

Must be application/json.

Path parameters

string

required

The unique identifier of the document to update. The document must be owned by your account; the API returns 404 for documents that do not exist or belong to another account.

Request body

All fields are optional. The API only modifies the fields you include in the request body.

string

New display name for the document. Minimum 1 character, maximum 200 characters.

string or null

New description. Maximum 2000 characters. Pass null explicitly to clear an existing description.

string

New chattel type classification ID. Must be one of the valid chattel type IDs. Returns 400 if the value is not recognized.

Response

Returns 200 OK with the updated document.

object

required

The full updated document object.

Show document properties

string

required

Unique document identifier.

string

required

Updated title.

string or null

required

Updated description, or null.

string

required

Updated chattel type ID.

string

Your account ID.

string

required

ISO 8601 timestamp of when the document was originally created. Not affected by updates.

string

required

ISO 8601 timestamp of this update.

object or null

required

The unchanged loan record, or null if no loan is attached.

Show loan properties

string

required

Name of the lending institution.

number

required

Original principal amount.

number

required

Outstanding balance.

string

required

ISO currency code.

string or null

required

Loan maturity date or null.

string

required

"CURRENT" or "BEHIND".

Example

curl --request PATCH \
  --url https://your-api.example.com/v1/documents/doc_01j9z8x7w6v5u4t3s2r1q0p \
  --header 'Authorization: Bearer <your-session-token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "2022 Ford F-150 — Revised Loan Package"
  }'

curl --request PATCH \
  --url https://your-api.example.com/v1/documents/doc_01j9z8x7w6v5u4t3s2r1q0p \
  --header 'Authorization: Bearer <your-session-token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Jet Ski — Hull ID SC2209AA",
    "description": "Personal watercraft acquired at auction, title transferred April 2026",
    "chattelType": "boat_watercraft"
  }'

curl --request PATCH \
  --url https://your-api.example.com/v1/documents/doc_01j9z8x7w6v5u4t3s2r1q0p \
  --header 'Authorization: Bearer <your-session-token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": null
  }'

{
  "document": {
    "id": "doc_01j9z8x7w6v5u4t3s2r1q0p",
    "title": "Jet Ski — Hull ID SC2209AA",
    "description": "Personal watercraft acquired at auction, title transferred April 2026",
    "chattelType": "boat_watercraft",
    "userId": "usr_clerk_abc123",
    "createdAt": "2026-03-15T10:30:00.000Z",
    "updatedAt": "2026-04-27T15:42:00.000Z",
    "loan": {
      "providerName": "First National Auto Finance",
      "originalAmount": 42500,
      "remainingAmount": 38200,
      "currency": "USD",
      "maturityDate": "2029-03-15",
      "status": "CURRENT"
    }
  }
}

Error cases

Status	Error message	Cause
`400`	`Invalid body.`	A field value fails schema validation, for example `title` exceeds 200 characters.
`400`	`Invalid chattelType.`	The `chattelType` value is not a recognized chattel type ID.
`401`	`Missing Authorization Bearer token.`	No `Authorization` header was sent.
`401`	`Invalid or expired token.`	The Bearer token is malformed or has expired.
`404`	`Not found.`	No document with the given `id` exists, or it belongs to a different account.

Overview

Documents

Signing

Workspace

Update an existing chattel document

Request headers

Path parameters

Request body

Response

Example

Error cases

​Request headers

​Path parameters

​Request body

​Response

​Example

​Error cases

Request headers

Path parameters

Request body

Response

Example

Error cases