Bulk create candidate lists

Creates up to 100 empty candidate lists in the caller's organization in one request. Each item takes the same fields as creating a single list. The request is rejected with 400, and nothing is created, when the body is invalid, it holds more than 100 lists, or two lists share an externalId. Otherwise each list succeeds or fails on its own, and results reports every list by its index in the request. A list naming an unknown owner or team fails without affecting the others. A list whose externalId is already held by a list in the organization is not created again: it is reported as existing with that list's id, and the existing list is left unchanged, so a batch can be retried safely.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The lists to create

Payload for creating candidate lists in bulk.

string
length between 1 and 255

Your own identifier for the organization every list in the request is created in, instead of the one x-organization-id names. Resolved and authorised as on single create; unknown or ambiguous values return 400, an organization the user cannot reach 403.

lists
array of objects
required
length between 1 and 100

The lists to create, each in the same shape as creating a single list. No two may share an externalId.

lists*
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json