API Reference

candidate.createNote

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

Creates a note on a candidate.

Requires the candidatesWrite permission.

For notes submitted with a type of text/html, we support the elements listed below. Any unsupported elements will be stripped out of the note's content before posting.

  • Bold <b>
  • Italic <i>
  • Underline <u>
  • Links <a>
  • Bulleted Lists - <ul>, <li>
  • Ordered Lists - <ol>, <li>
  • Code - <code>
  • Code Block - <pre>
Body Params
uuid
required
required
boolean
Defaults to false

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

boolean
Defaults to 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.

date-time
Response

Updated 5 months ago

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