NGngpvan

/people/{vanId}/canvassResponses

Changed on

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.

post/people/{vanId}/canvassResponses

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/people/{vanId}/canvassResponses
  • Auth
    HTTP basic

Path parameters

vanIdinteger required

Unique person identifier available in the current context

Request body

resultCodeIdinteger

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.

Response

200

Changes