API - Add Candidate to Rollup List on Creation


Currently contains 3 posts


June 21, 2019 15:48


I’m trying to figure out how to add a candidate to a particular rollup at creation time, but nothing I have tried seems to work and I want to make sure that I’m understanding the API docs correctly (I assume I’m not, or this would be working).

My understanding is that the desired rollup list membership is an array of RollupListMember objects, which have a RollupCode property set to the code identifying the rollup. For testing purposes, I created a public rollup with code “CSPEE.0001” and a dummy candidate with my own information. The test request is in Postman (which has worked wonderfully with the PCR API thus far). Here’s the pertinent request information:

API Endpoint – POST /candidates

JSON body:
“FirstName”: “Christian”,
“LastName”: “Speegle”,
“ShowOnWebRollup”: “1”,
“RollupListMembership”: [
“RollupCode”: “CSPEE.0001”

After creation, the API returns the CandidateId as expected. However, when requesting the candidate info via GET /candidates/{id}, RollupListMembership is null. (To clarify, I am adding RollupListMembership to FieldsPlus and the returned value is null – I’m not just saying it’s null because I don’t see it.)

Any help would be appreciated here. It’s not a HUGE deal if there’s no way to do what I want to do, but it would save me some manual work later so if possible I would like to add candidates via the API at creation time.


June 21, 2019 16:17


In order to add a name to a rollup list the endpoint you’ll want to use is:
POST /candidates/rolluplists/{RollupCode}/{CandidateId}


June 21, 2019 16:26


Thank you very much. That’s working for me now, I appreciate it.

Reply to thread