Skip to main content
PATCH
Edit a factory task
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

PATCH /api/v2/factories/updateTask changes a task’s title, description (null clears it), priority or tags, and answers the updated FactoryTaskDetail. Send id and at least one field to change; a body with nothing to change is 400 with Nothing to update, and any other key is 400 bad_request. The task must belong to a factory you may read. A missing, malformed or unreadable task, or one with no factory, is 404 resource_missing. You need projects:manage at the task’s home (its factory’s org unit), the key Console’s task edit checks. Without it the answer is 403 with requiredPermission: "projects:manage". Pass expectedUpdatedAt from your last read to refuse a stale edit. If the task changed since then, the answer is 409 conflict and nothing is written. Editing a task schedules nothing.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Path Parameters

taskId
string
required
Minimum string length: 1

Body

application/json
title
string

1-200 characters, not blank.

Required string length: 1 - 200
Pattern: \S
description
string | null

At most 20,000 characters; null clears it.

Maximum string length: 20000
priority
enum<string>
Available options:
low,
medium,
high,
urgent
tags
string[]

At most 20 tags of 1-64 characters each, none blank.

Maximum array length: 20
Required string length: 1 - 64
Pattern: \S
expectedUpdatedAt
number

The task's updatedAt you last read; a different value answers 409 conflict.

Response

The task as written

data
object
required

A factory task with its description (null when it has none). Tasks are written with createTask, updateTask, assignTask and transitionTask; starting factory work is done by a person in Console.

meta
object
required