Skip to main content

Submit candidates

POST 

/candidates/submit

Step 2 of 2. Save reviewed candidates into a job's pipeline. This is the call that creates records.

For each candidate, Tarkflo creates the candidate and an application on the job, attaches the CV when you pass its cv_id, and starts the job's workflow. When notify_candidate is true and the workflow has an invitation ready, the candidate is emailed. Whether an email actually goes out also depends on the job's workflow and your remaining interview minutes.

Send the values you reviewed, not the raw extraction. If a person fixed a name or phone number, send the fixed value.

Send an Idempotency-Key header with every call. If your request times out and you retry with the same key and body, you get the original response, marked with an Idempotent-Replayed: true header, and no one is added twice. Keys are remembered for 24 hours.

Up to 50 candidates per request. Rows succeed or fail independently: the response lists what was created and what failed, each with its index. If no row is created at all, the response is 422.

The role this key acts as needs the candidates:create permission.

Request​

Responses​

At least one candidate was created. Check failed for the rest.

Response Headers
    X-RateLimit-Limit

    Requests allowed in the current window for this key.

    X-RateLimit-Remaining

    Requests left in the current window.