Update a recruitment

Operation ID: updateRecruitment

Group: People Management › Recruitments

Open in the interactive reference

PATCH /people/recruitments/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates a recruitment with the fields you send. A field you leave out keeps its current value.

Use the recruitment's id, not its recruitmentNumber.

A new hiring manager or owner also gets the permissions to work on the opening.

The response is empty. Read the updated recruitment with GET people/recruitments/:id.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier of the recruitment you want to update.

Request body

Required, application/json: updateRecruitmentInput.

Field Type Required Description
name string no The name of the opening.
category string no A free-text category of the opening, for example internal, external or student.
deadline string no The application deadline. Use format YYYY-MM-DD. The status is derived from it.
vacancies number no The number of vacant positions the opening covers, from 0 to 1000.
departmentId string no The identifier of the department to move the opening to. See id on GET people/departments/:id.
positionId string no The identifier of the position to recruit for. See id on GET people/positions/:id.
teamId string no The identifier of the team. See id on GET people/teams/:id.
locationId string no The identifier of the work location. There is no endpoint for it.
entityId string no The legal entity that will employ the hire.
employmentCategoryId string no The identifier of the employment category. There is no endpoint for it.
hiringManagerId string no The identifier of the employee to make hiring manager. They are granted the permissions to work the opening. See id on GET people/person/:id.
ownerId string no The identifier of the employee to make recruitment owner, the recruiter. They are granted the permissions to work the opening. See id on GET people/person/:id.
jobDescription string no The job description, as plain text. Changing it does not re-score applicants already in the pipeline.
viabilityCriteria string no The internal viability criteria used to screen applicants, as plain text. Changing it does not re-score applicants already in the pipeline.
website string no The URL of the posting or the hiring team's page.
relocationRequired string no Whether and how relocation is required. Free text, not a boolean. 
{
  "name": "<name>",
  "category": "<category>",
  "deadline": "<deadline>",
  "vacancies": 0,
  "departmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "positionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "teamId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "employmentCategoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hiringManagerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "jobDescription": "<jobDescription>",
  "viabilityCriteria": "<viabilityCriteria>",
  "website": "<website>",
  "relocationRequired": "<relocationRequired>"
}

Response

200 Success

{
  "data": {},
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
REFERENCE_NOT_FOUND 400
INVALID_DEADLINE 400
INVALID_VACANCIES 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses