Update a candidate list by external ID

Updates the candidate list with the given external ID. Updates title, description and/or owner; at least one field must be provided; pass description: null to clear it. externalId is immutable and cannot be changed. 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 no list matches.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 256
^[\w.-]+$

Caller-supplied external identifier matching ^[\w.-]+$ (1-256 characters).

Body Params

Fields to update

Payload for updating a candidate list. At least one field must be provided. externalId is immutable and cannot be changed after creation.

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.

Responses

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