Ingest candidate profiles

Ingest selected candidate profiles from a sourcing search into your Fribl workspace. Ingested profiles are processed and made available as candidates for matching against job descriptions. Billable — charges the sourcing_ingest action once per candidate in selected_ids; each is charged independently and failed imports are refunded. See GET /tokens/costs for live pricing.

POST /sourcing/ingest

Ingest candidate profiles

cURL

curl --request POST \
  --url https://api-service.fribl.co/api/v1/sourcing/ingest \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "session_id": "<string>",
  "selected_ids": [
    "<string>"
  ]
}
'

200

{
  "task_ids": [
    "<string>"
  ],
  "status": "<string>",
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

API key in UUID format. Include this header with every authenticated request.

Body

application/json

Request body for ingesting candidate profiles from a sourcing search.

session_id · string · required

Session ID from the sourcing search containing the profiles to ingest.

selected_ids · string[] · required

List of candidate profile IDs to ingest. Maximum 100 per request.

Maximum array length: 100

Response

200

application/json

Ingestion request accepted.

task_ids · string[] · required

Identifiers for the ingestion tasks created.

status · string · required

Status of the ingestion request.

message · string · required

Human-readable status message.