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

# /fileLoadingJobs

`POST /fileLoadingJobs`

Initiates a file-loading job by specifying the URL for a zipped CSV file, containing data to be loaded, and the action(s) to be taken on it.

## Request body

- object
  - `description` string — Required; A description of the job, to be included in notifications (whether via email or webhook). Maximum length is 255 characters. No HTML or HTML special character syntax. More precisely, input must not match this regex: `[\<>]+|&#`
  - `file` object — Required; A `file` object which describes the source file and columns to be acted on.
    - `fileName` string — **Required**; Name of the delimited file within the zip file accessible by `sourceUrl`.
    - `hasHeader` boolean — Optional; Indicates that the first line of the file should be skipped. A header row in the file will be not be used; column names are determined by the required `columns` array and the order the columns appear in the file. Defaults to `false`.
    - `sourceUrl` string — **Required**; URL at which a zip file containing `fileName` can be accessed. The following URL schemes (“protocols”) are supported: SFTP, FTPS, HTTPS. If authentication is required, the username and password should be included in the URL.
    - `columnDelimiter` string — Optional; Character that separates each each column; one of: `CSV` → comma (,) separated values, `Tab` → Tab separated values, `Pipe` → pipe (|) separated values. Defaults to `CSV`.
    - `columns` object[] — **Required**; An ordered array of `column` objects, describing each column of the source file (from left to right). At least one column is required.
      - `name` string — **Required**; A column’s unique name that can be referenced in actions (e.g., `VanID`). The name can consist of alphanumeric characters only; no spaces or punctuation are permitted. A column `name` must be present for every column in the uploaded file, listed in the order in which they appear in the file from left to right.
  - `actions` unknown[] — Required; An array of `action` objects, each defining an action to be taken. Each Job Action Type has different supported and required for the Action property. See the individual Action Type docs below for more info.
    - unknown
  - `listeners` object[] — Optional; An optional array of one or two `listener` objects indicating means of notification, email or webhook. Only one of each type can be specified.
    - `type` string — **Required**; A method of notification: `EMAIL` or `URL`; one of: `EMAIL` → Indicates that ‘value’ is an email address to which the details of a job’s success or failure should be sent., `URL` → Indicates that ‘value’ is a URL to which the details of a job’s success or failure will be posted. The results will be a JSON object sent via POST and will be formatted like a [notification](https://everyaction.readme.io/reference#notification) object.
    - `value` string — **Required**; A valid email address or URL (e.g., `datateam@mydomain.com`, `https://mydomain.com/vanjobs/notify/myInternalJobId`)

## Response `200`

200

- object
  - `jobId` integer

## Other responses

- `400` — 400

---

[API](https://skmtc.net/ngpvan/apis/van-crm.md) · [All operations](https://skmtc.net/ngpvan/apis/van-crm/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ngpvan/van-crm/versions/f9adfdbb3c56/schema)