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

post

https://api.securevan.com/v4/people/{personIdType}:{personId}/canvassResponses

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

Path Params

personIdType

string

required

Defaults to GWID

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

personId

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

resultCodeId

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

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

204204

400400