Docs

Jobs

Close a linked job

POST/v1/integration/jobs/{jobId}/close

Closes an Alfa job linked to an ATS job, for example when it is filled or closed in your ATS. The job stops taking applications, its job adverts are taken down, and any sourcing on it stops. A job already closed answers the same, so a retry is safe. Closing the ATS job with `PUT /v1/integration/ats-jobs/{externalJobId}` does not close the Alfa job; call this as well. A job that is not linked, or belongs to another company, is 404 `job_not_found`. Requires an API key with the `jobs:write` scope.

Requires an Alfa API key as a bearer token. How API keys work

Path parameters

  • jobIdstringrequired

    Alfa's id for the job.

Headers

  • Alfa-Company-Idstring

    The Company ID of the company to act for. Required with a platform key, and that company must have authorized your platform; a company key acts for its own company and can leave it out.

Responses

  • 204Success, with no response body.
  • 400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
  • 401The bearer token is missing, expired or invalid. Problem details
  • 403The caller may not perform this operation, or has no active organisation. Problem details
  • 404The resource does not exist or is not visible to the caller. Problem details
  • 422The request failed validation; `errors` lists each invalid field. Problem details
  • 429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
  • 500An unexpected error. Quote the `correlationId` to support. Problem details