---
title: "/canvassFileRequests"
method: POST
path: "/canvassFileRequests"
---

# /canvassFileRequests

`POST /canvassFileRequests`

## Request

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

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

## Request body

- object
  - `savedListId` integer: 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.
  - `webhookUrl` string: 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.
  - `type` integer: 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`

200

- object
  - `canvassFileRequestId` integer
  - `canvassFileRequestGuid` string
  - `savedListId` integer
  - `webhookUrl` string
  - `downloadUrl` string
  - `status` string
  - `type` integer
  - `dateExpired` string
  - `errorCode` unknown

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `4f2049fba5af`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ngpvan/apis/van-crm/changes/canvassFileRequests/post.md)

---

[API](https://skmtc.dev/ngpvan/apis/van-crm.md) - [All operations](https://skmtc.dev/ngpvan/apis/van-crm/llms.txt) - [OpenAPI document](https://skmtc.dev/ngpvan/apis/van-crm/revisions/4f2049fba5af?raw)