---
title: "Update an import job"
method: PATCH
path: "/api/jobs/import/{id}"
tags: ["Import Jobs"]
---

# Update an import job

`PATCH /api/jobs/import/{id}`

## Request

- Base URL: `https://api.atono.io`
- URL: `https://api.atono.io/api/jobs/import/{id}`
- Auth: API key in header `X-API-KEY`

## Path parameters

- `id` string, uuid, required

## Request body

- RequestImportJobUpdateResource
  - `data` ImportJobUpdateResource, required
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` ImportJobUpdateResourceAttributes, required
      - `state` 'VALIDATE' | 'SCHEDULE' | 'CLEANUP', required
      - `importOptions` ImportOptions, required
        - `userOption` 'ADD_AS_INACTIVE' | 'ADD_WITH_INVITATION', required
        - `itemTypeOption` 'ADD_AS_STORIES' | 'ADD_AS_BUGS' | 'SKIP', required
        - `duplicateItemOption` 'IMPORT' | 'SKIP', required
        - `projectKeys` string[], required
        - `projectMappings` ImportOptionsProjectMapping[], nullable
          - `projectId` string, required
          - `teamId` string, uuid, nullable
        - `teamMemberOption` 'IMPORT_INVOLVED_USERS' | 'IMPORT_ALL_TEAM_MEMBERS', required
        - `templateName` string, required
        - `markAsSampleData` boolean, required
        - `referenceDate` string, date-time, nullable

## Response `200`

updateImportJob 200 response

- SingleResourceBodyImportJobResource
  - `data` ImportJobResource: The returned resource, based on the request.
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` ImportJobResourceAttributes, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `path` string, required
      - `size` integer, required
      - `contentType` string, required
      - `state` 'SUBMITTED' | 'VALIDATING' | 'VALID' | 'SCHEDULED' | 'RUNNING' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'FAILED' | 'CLEANING' | 'CLEANUP_COMPLETED' | 'CLEANUP_FAILED', required
      - `importOptions` ImportOptions, required
        - `userOption` 'ADD_AS_INACTIVE' | 'ADD_WITH_INVITATION', required
        - `itemTypeOption` 'ADD_AS_STORIES' | 'ADD_AS_BUGS' | 'SKIP', required
        - `duplicateItemOption` 'IMPORT' | 'SKIP', required
        - `projectKeys` string[], required
        - `projectMappings` ImportOptionsProjectMapping[], nullable
          - `projectId` string, required
          - `teamId` string, uuid, nullable
        - `teamMemberOption` 'IMPORT_INVOLVED_USERS' | 'IMPORT_ALL_TEAM_MEMBERS', required
        - `templateName` string, required
        - `markAsSampleData` boolean, required
        - `referenceDate` string, date-time, nullable
      - `source` 'LINEAR' | 'JIRA' | 'JIRA_SYNC' | 'SAMPLE_DATA' | 'ATONO_IMPORT', required
      - `hostConfig` ImportJobHostConfig, required
        - `host` string, required
        - `user` string, email, required
        - `apiToken` string, required
    - `relationships` ImportJobResourceRelationships, required
      - `creator` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
    - `meta` ImportJobResourceMetadata, required
      - `preflightResult` ImportInfo, required
        - `importObjects` ImportInfoImportObject[], required
          - `type` string, required
          - `meta` unknown, required
        - `sideEffects` ImportInfoSideEffect[], required
          - `code` string, required
          - `title` string, required
          - `detail` string, required
          - `source` unknown, required
        - `errors` PreflightResultEntry[], required
          - `type` 'NOTICE' | 'SIDE_EFFECT' | 'NO_OP' | 'ERROR', required
          - `code` string, required
          - `title` string, required
          - `detail` string, required
          - `source` unknown, required
      - `jobResult` ImportInfo, required
        - `importObjects` ImportInfoImportObject[], required
          - `type` string, required
          - `meta` unknown, required
        - `sideEffects` ImportInfoSideEffect[], required
          - `code` string, required
          - `title` string, required
          - `detail` string, required
          - `source` unknown, required
        - `errors` PreflightResultEntry[], required
          - `type` 'NOTICE' | 'SIDE_EFFECT' | 'NO_OP' | 'ERROR', required
          - `code` string, required
          - `title` string, required
          - `detail` string, required
          - `source` unknown, required
  - `errors` ProblemDetail[]: A list of errors returned with the response, if the request could not be completed. Each object includes details about a specific issue.
    - `id` string: A unique identifier for this specific error occurrence. Useful for debugging and support.
    - `links` object, nullable: Links related to the error. May include a URL to relevant documentation or support resources.
    - `status` integer: The HTTP status code associated with the error (e.g., 400, 404, 422).
    - `code` string: An internal code that identifies the type or category of the error.
    - `title` string: A short summary of the problem.
    - `source` ProblemSource: Identifies the part of the request that caused the error. Only one source is present per error.
      - `pointer` string, nullable: Specifies the path to the field in the request body that caused the error.
      - `parameter` string, nullable: Identifies a query parameter in the request URL that caused the error.
      - `header` string, nullable: Identifies the request header that caused the error.
    - `detail` string: Additional information about the error, intended to provide more context than the title.
    - `meta` unknown
  - `meta` unknown
  - `included` unknown[]: A list of related resources included in the response, either automatically by the API or in response to an include parameter in the request. Each item contains a full resource object (e.g., users, teams, acceptance criteria).
    - unknown
  - `links` unknown

---

[API](https://skmtc.dev/atono/apis/backend-api.md) · [All operations](https://skmtc.dev/atono/apis/backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atono/apis/backend-api/revisions/78a57b1d8c3d?raw)