Creates a comment on the candidate's timeline. Required scope: w_candidates or w_comments. Accessible with all token types.

Here is a list of fields that can be provided for the comment object:

keytypedescription
body (required)stringThe comment's text
policystringThis sets the view rights of the comment. See below
attachmentobjectThis can include an attachment for the comment to be created.

Note: only one attachment may be created per comment through this API

The attachment field should have 2 attributes:

keytypedescription
name (required)stringThe filename of the attachment
data (required)stringThe payload of the attachment, encoded in base64

Comment Policy

Comment policy defines the visibility of the new comment. There are 3 categories for members: simple, recruiter and admin. The comments are always visible to admins. Depending on the values provided in this array you can have more fine grained visibility settings. The following table displays the possible outcomes:

Field ValueMemberRecruiterAdmin
[]
["simple"]
["simple", "recruiter"]

A complete request would be:

{
    "member_id": "3247e8c7",
  "comment": {
    "body": "He is really good",
    "policy": ["recruiter"],
    "attachment": {
      "name": "tiny.gif",
      "data": "R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs="
    }
  }
}
Language
Authentication
Header
URL
Click Try It! to start a request and see the response here!