Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Jobs/DELETE /v1/jobs/{jobId}/candidates
DELETE /v1/jobs/{jobId}/candidates
Remove study candidates from 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.Removes the candidates with the given ids from a job you can write to. Only candidates recorded for this job are removed; an id that belongs to another job, or that does not exist, is ignored. The response reports how many ids were sent, not how many rows were removed.
A project viewer cannot remove candidates. With a project-scoped API key, a job outside the key's projects returns 403.
Request
Path parameters
jobIdstring (uuid)
Job UUID.
Query parameters
idstring[]
Candidate id to remove. Repeat the parameter to remove several.
Responses
200 OK
The ids were processed
Response shape:
okboolean
deletedinteger
Number of ids sent
400 Bad Request
The job id is empty, or no
id was givenResponse 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
Removing candidates failed
Response shape: object
Was this page helpful?