Sign in

v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Recruiting

Create an application for a candidate in a specific position. You can include custom fields in the body of the request.

post/recruiting/applications/position/{positionId}/candidate/{candidateId}

Path parameters

positionIdstring required
candidateIdstring required

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Request body

stageIdstring
sourcestring
isDisqualifiedboolean
rejectionReasonstring

Example request

{
  "stageId": "6736144449cfd358beefb241",
  "source": "Website integration",
  "isDisqualified": true,
  "rejectionReason": "Not enough experience"
}

Response

CREATED

_idstring

The unique identifier of the application.

_positionIdstring

The id of the position.

_candidateIdstring

The id of the candidate who applied to the position.

stageIdstring

The id of the stage of this application.

sourcestring

The source of the entry (e.g., API, manual, agency, browserExtension).

isDisqualifiedboolean

If this application has been disqualified or not.

rejectionReasonstring

The reason why the candidate got rejected.

hiredDatestring date-time

Timestamp when the application was moved to the hired status. Omitted if the application was never hired.

rejectionDatestring date-time

Timestamp when the application was rejected. Omitted if the application was never rejected.

candidateOriginstring

The origin of the candidate's application.

_createdByIdstring

The unique identifier of the creator of the record.

_updatedByIdstring

The unique identifier of the updater of the record.

_createdAtstring date-time

The creation date of the record in ISO 8601 format.

_updatedAtstring date-time

The last update date of the record in ISO 8601 format.

Example response

{
  "_id": "674991418c06fbf3f190b111",
  "_positionId": "674991418c06fbf3f190b222",
  "_candidateId": "674991418c06fbf3f190b333",
  "stageId": "6736144449cfd358beefb241",
  "source": "Website integration",
  "isDisqualified": true,
  "rejectionReason": "Not enough experience",
  "hiredDate": "2024-12-01T09:15:00.000Z",
  "rejectionDate": "2024-12-01T09:15:00.000Z",
  "candidateOrigin": "api",
  "_createdById": "67223a2a77fb00d3fb70cbac",
  "_updatedById": "67223a2a77fb00d3fb70cbac",
  "_createdAt": "2024-11-29T10:02:41.345Z",
  "_updatedAt": "2024-11-29T10:22:14.143Z"
}