/people/{vanId}/canvassResponses

A Canvass Response encapsulates a complete interaction with a person: it may have a Result Code (if the person was unavailable) or it may have an array of responses such as Activist Codes, Survey Questions, and other Script elements. Optionally, additional information about the canvass interaction can be specified using the canvassContext property such as the date of the contact attempt (dateCanvassed) or the Contact Type (contactTypeId). Use this endpoint to record these interactions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Unique person identifier available in the current context

Body Params
canvassContext
object

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

int32
Defaults to 205

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
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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