Create note

post

https://harvest.greenhouse.io/v3/notes

Create a candidate note, log an email, or record an activity-feed entry on a candidate. note_type selects which: NOTE posts to the Notes tab, EMAIL logs an email into the activity feed (and requires the email_* fields), and ACTIVITY writes a free-form activity-feed entry. Other note types (interview, feedback, touchpoint, LinkedIn, etc.) are produced by Greenhouse features and cannot be created through this endpoint. The note is always attached to candidate_id; pass application_id as well to anchor it to a specific application — that application must belong to the same candidate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

candidate_id

integer

Id of the candidate the note is attached to. Required for every note. When application_id is also supplied, the application must belong to this candidate.

body

string

required

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

subject

string

Subject line on the note. Required when note_type is EMAIL; optional for NOTE and ACTIVITY.

note_type

string

enum

required

Classification of the note being created. NOTE posts a candidate note in the Notes tab; EMAIL logs an email into the activity feed and requires the email_* fields; ACTIVITY logs a free-form entry into the activity feed. Other note types (interview, feedback, touchpoint, etc.) are produced by Greenhouse features and cannot be created through this endpoint.

Allowed:

user_id

integer

Id of the Greenhouse user to record as the note's author. Defaults to the authenticated user when omitted.

email_from

array of strings

From addresses on the email being logged. Required when note_type is EMAIL and forbidden for other types.

email_from

email_to

array of strings

To addresses on the email being logged. Required when note_type is EMAIL and forbidden for other types.

email_to

email_cc

array of strings

Cc addresses on the email being logged. Required (may be an empty array) when note_type is EMAIL and forbidden for other types.

email_cc

visibility

string

enum

required

Who will be able to see this note. public is visible to anyone with access to the candidate, private requires the "see private notes" permission, and admin_only is restricted to Job Admins and Site Admins.

Allowed:

application_id

integer

Id of the application to anchor this note to. The application must belong to candidate_id. Omit for candidate-level notes that are not tied to any single application.

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful