Create Comment

Request format

In order to create a comment you must send a JSON:API spec JSON object representing a comment.

Required attributes

As a bare minimum, body_text, must be supplied. This represents the plain text content of the comment.

Note: It is not possible to add mentions when creating comments through the API. This can only be done through the web interface.

Required relationships

Only the commentable relationship is required when creating an application. This relationship is polymorphic, meaning that it can relate to either an application or a job seeker.

Note: All comments created through the API will be associated with the Company's system user account.

Notifications

When a comment is created the following notifications are sent out:

• New Comment Received is sent to relevant Pinpoint users

Examples

{
  "data": {
    "type": "comments",
    "attributes": {
      "body_text": "This candidate was fantastic!"
    },
    "relationships": {
      "commentable": {
        "data": {
          "type": "applications",
          "id": "1"
        }
      }
    }
  }
}