NGngpvan

/canvassFileRequests

Changed on

Use this endpoint to create a CSV (comma-separated values) file with details of contacts from a saved list.

post/canvassFileRequests

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/canvassFileRequests
  • Auth
    HTTP basic

Request body

savedListIdinteger

Integer ID of the saved list containing people to be included in the canvass file. The API key requesting the canvass file must have access to the saved list.

webhookUrlstring

Valid HTTPS URL to receive a message POST request when canvass file generation is complete. The message will be a JSON object identical to the body of the GET /canvassFileRequests/{canvassFileId} response for this canvass file request.

typeinteger

Integer ID of the type of canvass file to generate. The API key requesting the canvass file must be authorized to request the specified canvass file type. For SMS synchronization always use the value 102.

Response

200

canvassFileRequestIdinteger
canvassFileRequestGuidstring
savedListIdinteger
webhookUrlstring
downloadUrlstring
statusstring
typeinteger
dateExpiredstring
errorCodeunknown

Example response

{
  "canvassFileRequestId": 123,
  "canvassFileRequestGuid": "DC7309A7-19F5-4DC7-8437-33FDBBADC2DA",
  "savedListId": 555888,
  "webhookUrl": "https://webhook.example.org/canvassFileRequests",
  "downloadUrl": "https://vancanvassfiles.blob.core.windows.net/canvass-file/DC7309A7-2012-05-05T10:18:43.6007964-04:00.csv",
  "status": "Completed",
  "type": 102,
  "dateExpired": "2012-05-05T12:18:43.6007964-04:00"
}

Changes