API Reference

candidate.createNote

post
https://api.ashbyhq.com/candidate.createNote

Creates a note on a candidate.

Requires the candidatesWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The id of the candidate

string | object
required

The note to add to the candidate. Either a plain string, or an object { type, value } where type is text/plain or text/html.

Whether or not users who are subscribed to the candidate should be notified that the note was posted. Default is false.

Whether the note should be marked as private. Private notes require "Allow access to non-offer private fields?" API key permission to create and view. Default is false.

An ISO date string to set the note's createdAt timestamp

Response

Updated about 1 month ago

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

Updated about 1 month ago