Applicant pools

Create Applicant Pool

Once applicants have been created, you will then need to create an applicant pool to compile all of your applicants into a list.

Request body

You simply need to provide a label for the applicant pool in the request body.

Response

You will receive the pool id as well as your pool label in the response:

Add an applicant to an applicant pool

Once an applicant pool has been created, you can start to add applicants to this pool. You can add multiple applicants to a single pool, to create a list with multiple individuals.

Request body

You need to include an applicant id that has been previously generated in the body of this request.

Response

On a successful response you will simply receive a 204 status code.

Error response