v1

latestOpenAPI 3.0.12026-07-24251036.5 KB
Studies

Upload candidates to a study

Upload up to 5,000 candidates and add them to a study.

A 201 Created response means the upload was accepted and is still processing. Use the returned data.background_task.status_url to check its status. Wait until the status is finished before uploading another batch to the same study.

post/v1/studies/{study_id}/candidates

Path parameters

study_idinteger required

The study ID

Request body

Response

upload accepted

Example response

{
  "data": {
    "background_task": {
      "status_url": "/v1/studies/11111/candidate_uploads/abc123"
    }
  }
}