Change candidate stage

put

https://{company}.{environment}.com/api/v1/hire/jobs/candidate/stage

Move a candidate to another stage of the job: a hiring stage, Archived (archiveReasonId required) or Preboarding (department and location required)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

jobId

string

required

candidateId

string

required

Body Params

Request to move a candidate to another stage of a job.

stageId

string

required

length ≥ 1

Gets or sets the stage id: a hiring stage id of the job, or "Archived" / "Preboarding" (from GET jobs/stages).

stageChangeComment

string | null

Gets or sets the stage change comment. For Archived it is the archive comment, for Preboarding the internal note.

department

string | null

Gets or sets the department identifier. Required for Preboarding.

location

string | null

Gets or sets the location identifier. Required for Preboarding.

businessUnit

string | null

Gets or sets the business unit identifier. Optional for Preboarding.

archiveReasonId

int32 | null

Gets or sets the archive reason id (from GET jobs/stages). Required for Archived.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

500

Server Error

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200Success

400Bad Request