---
title: "Update Job"
method: PATCH
path: "/v2/jobs/{job_id}"
tags: ["Jobs"]
---

# Update Job

`PATCH /v2/jobs/{job_id}`

## Request

- Base URL: `https://sdk.nimbleway.com`
- URL: `https://sdk.nimbleway.com/v2/jobs/{job_id}`
- Auth: HTTP bearer

## Path parameters

- `job_id` string, required

## Request body

- UpdateJobRequestPublicV2: Partial update for an existing job; omitted fields are left unchanged.
  - `description` string, nullable: New description.
  - `destination` JobDestinationPublicV2: Where a job writes its results.
    - `format` 'jsonl' | 'csv' | 'parquet': Output file format.
    - `path` string, required: Destination path the output is written to.
    - `type` 'file' | 's3', required: Destination kind: a local 'file' or an 's3' bucket.
  - `display_name` string, nullable: New display name.
  - `inputs` JobInputsPublicV2: Configuration for the input data a job processes.
    - `data` object[], nullable: Inline list of input records. Used when type is 'inline'.
    - `file_path` string, nullable: Path to the input file; must start with 's3' or 'file_'. Used for 's3'/'file' types.
    - `type` 's3' | 'inline' | 'file', required: How inputs are supplied: an 's3' bucket, 'inline' records, or an uploaded 'file'.
  - `schedule` JobSchedulePublicV2: Cron-based schedule controlling when a job runs automatically.
    - `cron` string, required: Cron expression defining when the job runs.
    - `enabled` boolean, required: Whether the schedule is currently active.

## Response `200`

Successful Response

- JobPublicV2: A configured job: an agent plus its schedule, inputs, and destination.
  - `created_at` string, date-time, nullable: When the job was created.
  - `description` string, nullable: Free-text description of the job.
  - `destination` JobDestinationPublicV2: Where a job writes its results.
    - `format` 'jsonl' | 'csv' | 'parquet': Output file format.
    - `path` string, required: Destination path the output is written to.
    - `type` 'file' | 's3', required: Destination kind: a local 'file' or an 's3' bucket.
  - `display_name` string, nullable: Human-friendly job name shown in the UI.
  - `extract_template_name` string, nullable: Name of the extract template this job runs.
  - `id` string, required: Unique job identifier (job_<n>).
  - `inputs` JobInputsPublicV2: Configuration for the input data a job processes.
    - `data` object[], nullable: Inline list of input records. Used when type is 'inline'.
    - `file_path` string, nullable: Path to the input file; must start with 's3' or 'file_'. Used for 's3'/'file' types.
    - `type` 's3' | 'inline' | 'file', required: How inputs are supplied: an 's3' bucket, 'inline' records, or an uploaded 'file'.
  - `last_run_at` string, date-time, nullable: Timestamp of the most recent run.
  - `last_run_status` 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING', nullable: Status of the most recent run.
  - `name` string, required: Job name.
  - `schedule` JobSchedulePublicV2: Cron-based schedule controlling when a job runs automatically.
    - `cron` string, required: Cron expression defining when the job runs.
    - `enabled` boolean, required: Whether the schedule is currently active.
  - `updated_at` string, date-time, nullable: When the job was last updated.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/nimbleway/apis/nimble-sdk.md) - [All operations](https://skmtc.dev/nimbleway/apis/nimble-sdk/llms.txt) - [OpenAPI document](https://skmtc.dev/nimbleway/apis/nimble-sdk/revisions/75720b84c9d7?raw)