Alfa

Candidates

Add a note to a candidate

POST/v1/candidates/{candidateId}/notes

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

Path parameters

  • candidateIdinteger | stringrequired

Request body

  • notestringrequired

    at least 1 characters

Responses

  • 201Created.
  • 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