---
title: "SftpImport: Update job"
method: PUT
path: "/job/sftp-import/{id}"
tags: ["Jobs"]
---

# SftpImport: Update job

`PUT /job/sftp-import/{id}`

## Request

- Base URL: `https://api.lytics.io/v2`
- URL: `https://api.lytics.io/v2/job/sftp-import/{id}`
- Auth: API key in header `Authorization`

Update a SftpImport job

## Path parameters

- `id` string, required

## Query parameters

- `account_id` string

## Request body `*/*`

- object
  - `auth_ids` string[]: Authorization IDs associated with the Job
  - `config` object, required: Job configuration, unique per-workflow
    - `continuous_update` boolean: Run this import continuously checking for new files periodically
    - `delimiter` string: Input the delimiter of the file. Default delimiter is ",". Other common delimiters may be "|" (pipe) or ";". For tab delimited files enter "t"
    - `diff` boolean: On continuous imports, compare file contents to the previous file contents and import only rows that have changed. This is useful when only full data dumps are provided
    - `fields` string[]: Select fields to import. Leave empty to import all fields. If no field names appear, the delimiter may need to be adjusted. Also check to ensure the CSV file has an appropriate header row. Field selection is unavailable for Zip files larger than 100MB
    - `file_frequency` string: Choose how often a continuous import should expect a new file
    - `filename` string: Select the file to import, or if this is a continuous import of dated files e.g., file_20160218.csv, choose the earliest dated file to import, and all files will be imported from that date onward
    - `folder` string
    - `prefix` string: Enter the file name prefix. You may use regular expressions
    - `stream` string: Data stream name
    - `time_of_day` string: Time of day to start import.
    - `timestamps` string[]: Select one or more columns in the CSV that contains the timestamp of an event. Sort in order of importance (e.g., "Updated" should be above "Created"). If no fields are specified, the event will be timestamped with the time of the import. Timestamp selection is unavailable for Zip files larger than 100MB
    - `timezone` string: Timezone for time of day
  - `description` string: A user-defined description
  - `drop_events_during_quiet_window` boolean
  - `expires_at` string, date-time
  - `monitoring` object: Inline monitoring config. On write: omit to keep, null to clear, or a config to set.
  - `name` string, required: A user-defined name
  - `quiet_period` integer
  - `quiet_time_of_day` string
  - `quiet_timezone` string

## Response `200`

SftpImport Job

- object
  - `_meta` object: Response Metadata
  - `data` object: Response Payload
    - `account_id` string: Lytics Account ID
    - `anomaly_rule` ModelsAnomalyRuleResp
      - `aid` integer
      - `checks` ModelsRuleCheckConfigReq[]
        - `allowable_violations` integer
        - `interval` string
        - `lookback_count` integer
        - `max_threshold` integer
        - `metric_type` string
        - `min_threshold` integer
        - `type` string
        - `variance_pct` number
      - `created` string
      - `id` string
      - `subject_id` string
      - `subject_type` string
      - `updated` string
    - `api_token_auth_id` string: this is set when work is create using access token
    - `auth_ids` string[]: Authorization IDs associated with the Job
    - `config` object, required: Job configuration, unique per-workflow
      - `continuous_update` boolean: Run this import continuously checking for new files periodically
      - `delimiter` string: Input the delimiter of the file. Default delimiter is ",". Other common delimiters may be "|" (pipe) or ";". For tab delimited files enter "t"
      - `diff` boolean: On continuous imports, compare file contents to the previous file contents and import only rows that have changed. This is useful when only full data dumps are provided
      - `fields` string[]: Select fields to import. Leave empty to import all fields. If no field names appear, the delimiter may need to be adjusted. Also check to ensure the CSV file has an appropriate header row. Field selection is unavailable for Zip files larger than 100MB
      - `file_frequency` string: Choose how often a continuous import should expect a new file
      - `filename` string: Select the file to import, or if this is a continuous import of dated files e.g., file_20160218.csv, choose the earliest dated file to import, and all files will be imported from that date onward
      - `folder` string
      - `prefix` string: Enter the file name prefix. You may use regular expressions
      - `stream` string: Data stream name
      - `time_of_day` string: Time of day to start import.
      - `timestamps` string[]: Select one or more columns in the CSV that contains the timestamp of an event. Sort in order of importance (e.g., "Updated" should be above "Created"). If no fields are specified, the event will be timestamped with the time of the import. Timestamp selection is unavailable for Zip files larger than 100MB
      - `timezone` string: Timezone for time of day
    - `created` string
    - `deleted` boolean: The Job has been deleted
    - `description` string: A user-defined description
    - `drop_events_during_quiet_window` boolean
    - `expires_at` string, date-time
    - `id` string: A Lytics-assigned, immutable unique ID for the Job
    - `meta` object: Extra meta data about the job
    - `monitoring` object: Inline monitoring config. On write: omit to keep, null to clear, or a config to set.
    - `name` string, required: A user-defined name
    - `quiet_period` integer
    - `quiet_time_of_day` string
    - `quiet_timezone` string
    - `sleep_until` string
    - `status` 'runnable' | 'sleeping' | 'paused' | 'completed' | 'fault' | 'failed' | 'killed' | 'deleted' | 'unknown': The status of the job
    - `updated` string
    - `user_id` string: The user ID that created or updated the job
    - `workflow` string: The workflow slug
    - `workflow_id` string: The workflow ID
  - `request_id` string
  - `status` integer: HTTP Status Code

## Other responses

- `404`: Not Found
- `500`: Internal Server Error

## Changes

- **2026-11-03** `d8e975057aec`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lytics/apis/lytics-api/changes/job/sftp-import/:id/put.md)

---

[API](https://skmtc.dev/lytics/apis/lytics-api.md) - [All operations](https://skmtc.dev/lytics/apis/lytics-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lytics/apis/lytics-api/revisions/d8e975057aec?raw)
