Add an internal note

Attaches an internal note to the application 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

Body

application/json

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 new 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 rental application with this id exists, or it belongs to another company. Both cases look identical so that ids cannot be probed across companies.

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.

Notes are staff-facing

These notes are separate from the comment field on an employment, address, pet, or vehicle entry. They are not included in the application PDF that Generate the application PDF produces, and nothing in this reference shows them to the applicant.