Docs

Outbound sourcing

Start sourcing on a job (deprecated path)

POST/v1/integration/jobs/{jobId}/outbound-sourcing

This operation is deprecated and will be removed. Use its replacement.

Deprecated alias of `POST /v1/integration/jobs/{jobId}/sourcing`. Spends the company's sourcing credits on a campaign for a live, linked Alfa job, as when a recruiter boosts the job in Alfa. Alfa decides where the credits go: it can advertise the job on job boards and search professional profiles for people who fit it, choosing the mix from the kind of role and where it is advertised. Each credit buys seven days of reach and uses one of the company's sourcing credits, however many channels Alfa uses. Each candidate Alfa finds by searching profiles reaches you as a `src_…` candidate with status `sourced_potential`, through webhooks and the candidates list; people who apply through a job ad arrive as applicants. Sending the same `requestId` again answers with the same campaign and starts nothing; reusing it with different credits is 409 `request_id_reused`. A job that is not linked, or belongs to another company, is 404 `job_not_found`; a job that is not live is 409 `job_not_live`; a company with sourcing switched off is 403 `sourcing_disabled`; too few sourcing credits left is 409 `insufficient_sourcing_credits`. Requires an API key with the `sourcing: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.

  • 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

  • creditsintegerrequired

    The sourcing credits to spend, from 1 to 10. Each credit buys seven days of reach across the channels Alfa chooses and uses one of the company's sourcing credits. For a job advertised in several locations, send a multiple of the number of locations.

    minimum 1 · maximum 10

  • requestIdstringrequired

    Your unique id for this request. Sending it again returns the same campaign and starts nothing.

    format uuid

Response body

  • campaignIdintegerrequired

    Alfa's id for the campaign.

  • requestIdstring | nullrequired

    The `requestId` the campaign was started with, or null for a campaign a recruiter started in Alfa.

  • creditsintegerrequired

    The sourcing credits the campaign charged.

  • status"pending" | "running" | "complete"required

    `pending` until Alfa starts searching, `running` while it finds candidates, then `complete`.

  • startedAtstringrequired

    When the campaign was started.

Responses

  • 202Accepted for background processing.
  • 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