API Reference

Add candidates to a list by external ID

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

Adds one or more candidate profiles to the list with the given external ID, addressed by profile id (candidateIds) and/or external id (candidateProfileExternalIds). Candidates already on the list are skipped, so the call is idempotent. Returns 204 on success, 400 when a candidate external id matches no candidate, and 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

Candidates to add, by profile id and/or external id

Candidates to add to or remove from a list, addressable by Popp candidate profile id and/or by caller-supplied external id. Provide at least one id across the two fields; the combined total cannot exceed 100.

candidateIds
array of uuids
length ≤ 100

Candidate profile ids (UUIDs).

candidateIds
candidateProfileExternalIds
array of strings
length ≤ 100

Candidate profile external ids, resolved to profile ids within the caller's organization. An external id that matches no candidate returns 400.

candidateProfileExternalIds
Responses
204

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?