NGngpvan

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

Changed on

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.

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

Request

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

Path parameters

vanIdinteger required

Required; Unique person identifier available in the current context.

canvassResponseIdinteger required

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

Request body

Response

204

object required

Changes