Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Applicant Tracking
Public API

Update Applicant Status

Update the status of an application. The authenticated caller must have access to ATS settings. Use the Get Applicant Statuses endpoint to obtain valid status IDs.

OAuth Scopes: hiring:applications.write

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

Path parameters

applicationIdinteger required

The ID of the application whose status should be updated.

Request body

statusinteger required

The ID of the status to assign to the application. Use the Get Applicant Statuses endpoint to get available status IDs.

Example request

{
  "status": 2
}

Response

Success. Returns the type and ID of the status change record.

typestring

Always 'positionApplicantStatus'

idinteger

The ID of the created status change record