Skip to content
BookendBookend Docs

Update a loan package

PATCH
/v1/loans/{ref}
curl --request PATCH \
  --url http://localhost:8080/v1/loans/example \
  --header 'Content-Type: application/json' \
  --data '{ "borrowerName": "example", "expectedPrincipal": "example", "assigneeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "clearAssignee": true }'

Changes the borrower name, the expected principal (decimal string) and/or the assignee of the latest package version; null fields are left untouched and clearAssignee unassigns. Assigning a user is chained into evidence and emails the assignee. Admin, manager or specialist, or an API key with intake:write. 404 for an unknown reference, 409 when the loan is sealed or rejected, 400 when assigneeId is not a user.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ref
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Body of PATCH /v1/loans/{ref}. Null leaves a field untouched; bool UpdateLoanRequest.ClearAssignee unassigns.

object
borrowerName
null | string
expectedPrincipal
null | string
assigneeId
null | string format: uuid
clearAssignee
boolean
Examplegenerated
{
  "borrowerName": "example",
  "expectedPrincipal": "example",
  "assigneeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "clearAssignee": true
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
string format: uuid
externalRef
required
string
packageVersion
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
borrowerName
required
string
expectedPrincipal
required
null | string
state
required
string
hasExceptions
required
boolean
assigneeId
required
null | string format: uuid
createdBy
required
null | string format: uuid
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "externalRef": "example",
  "packageVersion": 1,
  "borrowerName": "example",
  "expectedPrincipal": "example",
  "state": "example",
  "hasExceptions": true,
  "assigneeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "createdBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "createdAt": "2026-04-15T12:00:00Z",
  "updatedAt": "2026-04-15T12:00:00Z"
}