Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Jobs/POST /v1/jobs/{jobId}/candidates
POST /v1/jobs/{jobId}/candidates
Record study candidates for a job
Auth: required. Send an
ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key), a Clerk session JWT (Authorization: Bearer …) or the Clerk __session cookie (browser sessions). See Authentication.Adds candidates to a job you can write to, or updates the ones already recorded. A row is matched on molecule_id, compound_id and source together. Each row carries a status of selected, defer, reject or retest, which the route does not check against that list. The response reports how many rows were sent, not how many changed.
A project viewer cannot record candidates. With a project-scoped API key, a job outside the key's projects returns 403.
Request
Path parameters
jobIdstring (uuid)
Job UUID.
Request body
rowsobject[]
Example
Responses
200 OK
The rows were recorded
Response shape:
okboolean
upsertedinteger
Number of rows sent
400 Bad Request
The job id is empty, or
rows is missing or emptyResponse shape: object
401 Unauthorized
Authentication required
Response shape: object
403 Forbidden
You cannot write to the job, or it is outside your API key's project scope
Response shape: object
429 Too Many Requests
Rate limit exceeded
Response shape: object
500 Internal Server Error
Recording candidates failed, or the body is not valid JSON
Response shape: object
Was this page helpful?