v1

latestOpenAPI 3.1.02026-07-2432063.2 KB

/voterRegistrationBatches/{batchId}/people

Add Registrants to a Voter Registration Batch

Description

Use this endpoint to submit up to 25 registrants to a Voter Registration Batch. Fields published via POST /voterRegistrationBatches should be specified in CustomProperties.

post/voterRegistrationBatches/{batchId}/people

Path parameters

batchIdinteger required

Required; unique identifier of the Voter Registration Batch

Request body

Response

200

alternateIdstring

vanIdstring

resultstring

{"stackTrail":"paths:/voterRegistrationBatches/{batchId}/people:post:responses:200:content:application/json:schema:items:properties:errors","oasType":"schema","type":"unknown"}

Example response

[
  {
    "alternateId": "ab694282-1d74-474b-90dc-173aa73f44b1",
    "vanId": "10000000",
    "result": "Success"
  }
]