Update a candidate list

Updates a candidate list's title, description, owner and/or externalId. At least one field must be provided; pass description: null to clear it. Pass externalId to set or change the list's external ID, or externalId: null to clear it; the list's id does not change. An externalId already held by another list in the organization returns 409, and lookups by external ID can take a moment to reflect a change. Pass owner (an email) to hand the list to another user of the organization; an unknown email or one outside the organization returns 400. Returns 404 when the list is not found in the caller's organization.

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

Candidate list id (UUID).

Body Params

Fields to update

Payload for updating a candidate list. At least one field must be provided.

string
length between 1 and 255

New name of the list.

string | null

New description. Pass null to clear it.

string

Email of the Popp user to hand the list to. The user must have access to the caller's organization, otherwise the request is rejected with 400.

string | null
^[\w.-]+$

New external identifier for the list. Pass null to clear it. Must be unique within the organization, otherwise the request is rejected with 409. The list's id does not change. Lookups by external id can take a moment to reflect a change.

teams
array
length ≤ 50

Replaces the teams the list is shared with, each by Popp id or externalId. Pass an empty array to make the list visible to its owner only. Every team must belong to the caller's organization, otherwise the request is rejected with 400.

teams
Responses

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