Alfa

Candidates

Send emails Lisa drafted to candidates

POST/v1/candidates/bulk-email

Held back: refuses with 403 `FEATURE_DISABLED` until sending from chat ships.

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

Headers

  • Idempotency-Keystring

    A unique value, such as a UUID, sent unchanged on every retry of one request. A retry after the request succeeded returns the same response, marked `Idempotent-Replayed: true`, without running the operation again. Reusing a key for a different request is a 422.

    at least 1 characters · at most 255 characters

Request body

  • emailsobject[]required

    at least 1 items

    Show fields
    • candidateIdintegerrequired

      greater than 0

    • subjectstringrequired
    • bodyHtmlstringrequired

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
  • 409The resource is not in a state that allows this, or a request with the same `Idempotency-Key` is still running. 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