Update an internal note

Replaces the text and section of an existing note and returns it. Requires the rental_applications:write permission.

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

applicationIdstringrequired

The rental application to work with. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

idstringrequired

The note to work with. A Snowflake id, sent as a decimal string.

example: 1832847410293847552

Body

application/json

Both fields are required — this is a replace, not a merge.

sectionstringrequired

Which part of the application the note is about, as free text — the server does not check it against a list. Between 1 and 100 characters.

commentstringrequired

The note itself. Between 1 and 500 characters.

Response

200 · The updated note.

idstring

The comment.

sectionstring

Free-text label for the part of the application the comment is about, for example "screening". Not a fixed set — whatever the caller stored is returned.

commentstring

The comment text.

createdstring · date-time

When the comment was written, in the company's timezone.

updatedstring · date-time

When the comment was last edited, in the company's timezone.

401 · The access token is missing, expired, or not valid.

403 · The caller is authenticated but does not hold the `rental_applications:write` permission.

404 · No note with this id exists on this rental application, or the rental application itself was not found.

Allowed in every application status

This is not gated on the application's status — it works on a draft, on a submitted application, and on a retracted one. Only the applicant-facing portal locks an application once it is submitted.