API Reference

/people/{vanId}/canvassResponses/{canvassResponseId}

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

Use this endpoint to PATCH the SMS Opt-In value of a phone in the canvassContext body parameter of a canvass response. Attempting to PATCH other properties of a canvass response will result in a 400: Bad Request error response.

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

Required; Unique person identifier available in the current context.

int32
required

Required; Unique canvass response identifier. Retrieve this from GET /people/{vanId}/canvassResponses/{referenceId}

Body Params
canvassContext
object

Required; describes the context in which this Canvass Response was created.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
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