Sign in
Applicant Tracking
Public API

Create Job Application Comment

Add a comment to an application. The authenticated caller must have access to ATS settings. The type field defaults to comment if omitted.

OAuth Scopes: hiring:applications.write

post/api/v1/applicant_tracking/applications/{applicationId}/comments

Path parameters

applicationIdstring required

The ID of the application to add a comment to.

Request body

typestring

The comment type. Defaults to comment if omitted.

commentstring required

The comment being posted.

Example request

{
  "type": "comment",
  "comment": "I really like this applicant"
}

Response

Success. Returns the type and ID of the created comment.

typestring

The type of comment created, e.g. 'comment'

idinteger

The ID of the newly created comment

Changes

No recorded changes to this endpoint across all 1 revision of this API.