/candidates/:id/comments

POST https://{subdomain}.workable.com/spi/v3/candidates/{id}/comments

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:

key	type	description
body (required)	string	The comment's text
policy	string	This sets the view rights of the comment. See below
attachment	object	This 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:

key	type	description
name (required)	string	The filename of the attachment
data (required)	string	The payload of the attachment, encoded in base64

Comment Policy

Comment policy defines the visibility of the new comment. There are 6 categories for members: admin (includes all access), recruiting_admin, hiring_manager, simple (standard members), reviewer and recruiter. 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 Value	Recruiter	Reviewer	Simple	Hiring Manager	Recruiting Admin	Admin
[]	‒	‒	‒	‒	‒	✔️
["admin"]	‒	‒	‒	‒	‒	✔️
["recruiter", "admin"]	✔️	‒	‒	‒	‒	✔️
["recruiting_admin", "admin"]	‒	‒	‒	‒	✔️	✔️
["recruiter","recruiting_admin", "admin"]	✔️	‒	‒	‒	✔️	✔️
["hiring_manager","recruiting_admin", "admin"]	‒	‒	‒	✔️	✔️	✔️
["recruiter","hiring_manager","recruiting_admin", "admin"]	✔️	‒	‒	✔️	✔️	✔️
["simple","hiring_manager","recruiting_admin", "admin"]	‒	‒	✔️	✔️	✔️	✔️
["reviewer","simple","hiring_manager","recruiting_admin", "admin"]	✔️	‒	✔️	✔️	✔️	✔️
["reviewer","simple","hiring_manager","recruiting_admin", "admin"]	‒	✔️	✔️	✔️	✔️	✔️
["recruiter","reviewer","simple","hiring_manager","recruiting_admin", "admin"]	✔️	✔️	✔️	✔️	✔️	✔️

A complete request would be:

JSON

{
	"member_id": "3247e8c7",
  "comment": {
    "body": "He is really good",
    "policy": ["recruiter","admin"],
    "attachment": {
      "name": "tiny.gif",
      "data": "R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs="
    }
  }
}

The mapping between the values and the names of the collaboration roles in Workable is the following:

admin corresponds to Admin. recruiting_admin corresponds to Recruiter. hiring_manager corresponds to Hiring Manager. simple corresponds to Hiring Contributor. reviewer corresponds to Candidate Reviewer. recruiter corresponds to External Recruiter.