post
https://api.securevan.com/v4/voterRegistrationBatches//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.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Response
| Property | Type | Description |
|---|---|---|
alternateId | string | A Unique Identifier, for your reference only. Value is not stored in the database. |
vanId | string | If result is Success, the vanId of the registrant’s record. |
result | string | Success or Failure |
errors | object | If result is Failure, an array of Error objects. |
Note
The code generated by the sidebar will cause an error. This endpoint requires the JSON body to consist only of the array of registrant objects, without a key, so the request body should look like the following example.
[
{
"person": {
"firstName": "john",
"lastName": "doe"
},
"customProperties": [
{
"key": "VR:HasCat",
"value": "true"
}
]
}
]