Alfa

Candidates

Change a candidate's pipeline status or board column

PATCH/v1/candidates/{candidateId}/workflow

Sets the status (`null` clears it) and, when given, its feedback. `customColumnId` pins the card to a custom column, `null` unpins it and leaving it out keeps the current pin. Moving into the Interview column emails a booking link.

Requires the session token of a signed-in Alfa user as a bearer token.

Path parameters

  • candidateIdinteger | stringrequired

Request body

  • statusstring | nullrequired
  • feedbackstring
  • customColumnIdinteger | null
  • jobIdinteger | string

Responses

  • 200Success.
  • 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