Skip to main content
PATCH
Update a workstream
Changes a workstream’s name, description, ownerKind, ownerRefId or status; send id and at least one field. Status ARCHIVED archives the workstream: workstreams are never deleted over the API. An unknown id is 404 resource_missing. The credential needs both the projects:manage and objectives:read scopes, and objectives:read and projects:manage granted at the deployment root; otherwise 403 permission_denied names the first missing permission and nothing is written. The body is strict: unknown fields are 400 bad_request. Success is 200 with the PlanningWorkstream. With a key, a same-key retry within 24 hours returns the recorded result while the caller still holds both permissions at the deployment root; otherwise 409 idempotency_result_unavailable, and the write never runs twice. Reconcile an unknown outcome with Get workstream.

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

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

workstreamId
string
required

The workstream ID, as the planning reads return it.

Required string length: 1 - 200

Body

application/json

The fields to change; omitted fields are unchanged. At least one field besides id is required. Unknown fields are refused. Set status ARCHIVED to archive; workstreams are never deleted over the API.

name
string

Stored exactly as sent; at most 200 characters and not blank.

Maximum string length: 200
description
string

At most 4,000 characters.

Maximum string length: 4000
ownerKind
enum<string>

Who owns it: the company, a department or a team. Never a person.

Available options:
company,
department,
team
ownerRefId
string

The owning company, department or team identifier, recorded as sent.

Required string length: 1 - 200
status
enum<string>

ARCHIVED archives the workstream.

Available options:
ACTIVE,
ARCHIVED

Response

Update a workstream

data
object
required
meta
object
required