API Reference›Servicing Plane›Case notes›Revise a case note

Revise a case note

PUThttps://sandbox.api.lendeasy.ai/v1/servicing/notes/{noteId}ImplementedBearer token ·UPDATE_SERVICING_NOTE

Appends a new revision while preserving note identity and immutable revision history.

Request

curl -X PUT https://sandbox.api.lendeasy.ai/v1/servicing/notes/$NOTE_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Customer supplied the final filing page through secure upload.",
  "sensitive": true,
  "pinned": false,
  "flagged": false,
  "changeReason": "Recorded verified receipt."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/notes/${noteId}`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "body": "Customer supplied the final filing page through secure upload.",
  "sensitive": true,
  "pinned": false,
  "flagged": false,
  "changeReason": "Recorded verified receipt."
}),
});

requests.put(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/notes/{note_id}",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "body": "Customer supplied the final filing page through secure upload.",
  "sensitive": true,
  "pinned": false,
  "flagged": false,
  "changeReason": "Recorded verified receipt."
},
)

{
  "resourceId": 7201,
  "changes": {
    "revision": 2,
    "fieldKeys": [
      "body",
      "pinned"
    ]
  }
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Opaque active LendEasy tenant-registry identifier. Supply exactly one instance; no alternate tenant selector is accepted.
noteId required in path	integer	Positive numeric note identifier.
Idempotency-Key optional in header	string	Optional replay key for this logical mutation. Omission creates a fresh server-owned key for this attempt; blank, repeated, or longer-than-50-character values are rejected.

Body parameters

Field	Type	Description
body optional	string
sensitive optional	boolean
pinned optional	boolean
flagged optional	boolean
changeReason optional	string

Request

curl -X PUT https://sandbox.api.lendeasy.ai/v1/servicing/notes/$NOTE_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Customer supplied the final filing page through secure upload.",
  "sensitive": true,
  "pinned": false,
  "flagged": false,
  "changeReason": "Recorded verified receipt."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/notes/${noteId}`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "body": "Customer supplied the final filing page through secure upload.",
  "sensitive": true,
  "pinned": false,
  "flagged": false,
  "changeReason": "Recorded verified receipt."
}),
});

requests.put(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/notes/{note_id}",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "body": "Customer supplied the final filing page through secure upload.",
  "sensitive": true,
  "pinned": false,
  "flagged": false,
  "changeReason": "Recorded verified receipt."
},
)

{
  "resourceId": 7201,
  "changes": {
    "revision": 2,
    "fieldKeys": [
      "body",
      "pinned"
    ]
  }
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}