API Reference

/people/{personIdType}:{personId}/canvassResponses

post
https://api.securevan.com/v4/people/:/canvassResponses

This endpoint is the same as POST /people/{vanId}/canvassResponses but uses external IDs rather than VANIDs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Applying Activist Codes?

If you're applying an Activist Code to a Person outside of the context of a "canvass," consider setting canvassContext.omitActivistCodeContactHistory to true. This will keep a Contact History record from being generated (assuming you are applying only Activist Codes).

Path Params
string
required
Defaults to GWID

Required; a known person identifier type available in the current context

string
required
Defaults to 3

Required; an external identifier, URL encoded

Body Params
canvassContext
object

Optional; describes the context in which this Canvass Response was created

int32

Optional; specifies the Result Code of this Response. If no resultCodeId is specified, responses must be specified. Conversely, if responses are specified, resultCodeId must be null (a result of Canvassed is implied). The resultCodeId must be a valid Result Code in the current context.

responses
array of objects

Optional; an array of Script Responses. If specified, resultCodeId must be null. Each Script Response has a property that determines the response's type. This array can contain multiple types.

responses
Responses

Updated about 1 year ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago