GRgreenhouse
Job Notes

Create job note

Create a free-form note attached to a job. The note is anchored to the job referenced by job_id and authored on behalf of user_id; the resulting note is visible according to its visibility (admin_only_visible or privately_visible).

post/v3/job_notes

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/job_notes
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:job_notes:create
    • or HTTP bearer

Request body

job_idinteger required
user_idinteger required
bodystring required
visibility'admin_only_visible' | 'privately_visible' required

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
job_idinteger

Id of the job this note is attached to. Job notes are always anchored to a single job and are not shared across jobs.

user_idinteger

Id of the Greenhouse user who authored the note.

bodystring nullable

Free-text body of the note. Newline characters are stored verbatim and rendered as line breaks in the Greenhouse UI.

visibility'admin_only_visible' | 'privately_visible' | 'null' nullable

Who can see this note. admin_only_visible is restricted to users with Job Admin or higher access on the job; privately_visible is further restricted to users with the "view and create private job notes" permission on the job.

Changes

No recorded changes to this operation across all 1 revision of this API.