Update a candidate list

Updates a candidate list's title, description and/or externalId. At least one field must be provided; pass description: null or externalId: null to clear them. externalId must be unique within the organization. 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 | null
^[\w.-]+$

Caller-supplied external identifier for the list (unique within the organization). Pass null to clear it.

Responses

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