API Reference

Update a candidate list by external ID

patch
https://api.joinpopp.com/v1/candidates/lists/by-external-id/

Updates the candidate list with the given external ID. Updates 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 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.

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

Updated 2 days ago

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

Updated 2 days ago

Did this page help you?