Skip to content

Update Work Project

PATCH
/work/projects/{project_id}

Rename one project, re-describe it, or move its status.

Field PRESENCE is the contract: an omitted field keeps its stored value and description: null clears it. 403 unless the caller created the project or holds Owner/Admin — the SAME rule deletion uses, and the role half only answers correctly because of with_org_role.

Authorizations

Parameters

Path Parameters

project_id
required

Project id

string

Project id

Header Parameters

Idempotency-Key
Any of:
string

Retry-safety key. Replaying one returns the ORIGINAL result with duplicate: true instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry.

X-Target-Org-Id
Any of:
string

Request Body required

One project being changed. Field PRESENCE is the contract.

channel is absent on purpose: a project’s channel is where its messages and receipts already point, so moving one would strand them. Renaming, re-describing and moving its status are what this accepts.

object
description
Any of:
string
<= 2000 characters
name
Any of:
string
<= 500 characters
status
Any of:
string
Allowed values: active paused completed archived

Responses

200

Successful Response

object
data
required

The result of one project write, with its idempotent-replay marker.

object
compatibilityEventId
Any of:
string
duplicate
Any of:
boolean
project
Any of:

One project: a named unit of work attached to a channel.

object
channel
Any of:
string
createdBy
Any of:
string
description
Any of:
string
id
Any of:
string
name
Any of:
string
status
Any of:
string
key
additional properties
any
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string