ats
application

Update an application

Changed on
patch/ats/{connection_id}/application/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/ats/{connection_id}/application/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Application

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
candidate_idstring
job_idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

applied_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

hired_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rejected_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rejected_reasonstring
sourcestring
status'NEW' | 'REVIEWING' | 'SCREENING' | 'SUBMITTED' | 'FIRST_INTERVIEW' | 'SECOND_INTERVIEW' | 'THIRD_INTERVIEW' | 'BACKGROUND_CHECK' | 'OFFERED' | 'ACCEPTED' | 'HIRED' | 'REJECTED' | 'DECLINED' | 'WITHDRAWN'
original_statusstring

The integration's original status. Mostly used to have your customers chose the application status/stage so that your software can trigger an event.

user_idstring

HR user/employee ID (reference to HrisEmployee)

original_substatusstring

The provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage)

summarystring

Application personal summary (e.g. Pinpoint Personal Summary)

rawobject

Response

Successful

idstring
candidate_idstring
job_idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

applied_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

hired_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rejected_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rejected_reasonstring
sourcestring
status'NEW' | 'REVIEWING' | 'SCREENING' | 'SUBMITTED' | 'FIRST_INTERVIEW' | 'SECOND_INTERVIEW' | 'THIRD_INTERVIEW' | 'BACKGROUND_CHECK' | 'OFFERED' | 'ACCEPTED' | 'HIRED' | 'REJECTED' | 'DECLINED' | 'WITHDRAWN'
original_statusstring

The integration's original status. Mostly used to have your customers chose the application status/stage so that your software can trigger an event.

user_idstring

HR user/employee ID (reference to HrisEmployee)

original_substatusstring

The provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage)

summarystring

Application personal summary (e.g. Pinpoint Personal Summary)

rawobject

Changes

  • fbf77d34910fRevision changes
    • info

      added the new optional request property

    • info

      added the enum value summary to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status