Create a candidate list

Creates an empty candidate list in the caller's organization. title is required; description, externalId and owner are optional. externalId must be unique within the organization. owner is the email of the user who owns the list, defaulting to the API key's user; it must be a user of the organization.

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

Candidate list payload

Payload for creating a candidate list.

string
required
length between 1 and 255

Human-readable name of the list. Required.

string
length ≤ 2000

Optional free-text description of the list.

string
length between 1 and 256
^[\w.-]+$

Optional caller-supplied external identifier for the list. Must be unique within the organization.

string
length between 1 and 255

Your own identifier for the organization the list is created in, instead of the one x-organization-id names. Resolved within your organization group and checked against the access of the user the API key belongs to. Unknown or ambiguous values return 400, an organization the user cannot reach 403.

string

Email of the Popp user who owns the list. Defaults to the user the API key belongs to. The user must have access to the caller's organization.

teams
array
length ≤ 50

Teams to share the list with, each by Popp id or externalId. Every team must belong to the caller's organization. When omitted and the owner is in exactly one team, the list is shared with that team.

teams
Responses

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