Update note

Update a candidate note. Fields that are omitted are left unchanged, and the acting user must be a Site Admin or the note's author. The endpoint follows the Greenhouse UI: body and visibility can be edited on NOTE, TOUCHPOINT and FEEDBACK notes, visibility can only switch between public and admin_only on a NOTE that is not private, and any other change returns 422. Greenhouse's own internal integrations can also edit other note types, subject, user_id and the email fields. Changing body clears body_with_tags and removes the note's @-mentions, since the API takes plain text; sending the current body changes nothing.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
string
length ≥ 1

New free-text body of the note. Replaces the stored body. The API takes plain text, so a changed body also drops the @-mentions in body_with_tags, and users who could only see the note because they were mentioned lose access to it. Sending the current body changes nothing.

string
enum

New visibility. Matches the Greenhouse UI: only a NOTE that is not private can change visibility, and only between public and admin_only. Greenhouse internal integrations can set any value, where private requires the "see private notes" permission on the candidate.

Allowed:
string

New subject line. Greenhouse internal integrations only; other callers receive 422.

integer

Id of the Greenhouse user to record as the note's author. Must belong to the organization; deactivated users are accepted. Greenhouse internal integrations only; other callers receive 422.

email_from
array of strings

From addresses of the logged email. Only allowed on an EMAIL note, and only for Greenhouse internal integrations.

email_from
email_to
array of strings

To addresses of the logged email. Only allowed on an EMAIL note, and only for Greenhouse internal integrations.

email_to
email_cc
array of strings

Cc addresses of the logged email. Only allowed on an EMAIL note, and only for Greenhouse internal integrations.

email_cc
Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language
Credentials
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json