Skip to main content
PATCH
Update a project
Changes a project’s name, description, startDate, targetDate or purposeStatement. The body is strict: id plus at least one of those fields. Omitted fields are unchanged and nothing is cleared. The project must be readable by the caller (projects:read at its home); a missing, malformed, unhomed or unreadable ID answers 404 resource_missing. Changing it requires projects:manage at that home; otherwise 403 forbidden. Because the success returns the project, the credential’s scopes must include projects:read as well as projects:manage; otherwise 403 permission_denied naming projects:read, and nothing is written. API keys and External Apps can both update. Success is 200 with the post-write Project. With an Idempotency-Key, a same-key retry within 24 hours returns the recorded result while the caller’s scopes still include projects:read and it may still read and change the project; otherwise 409 idempotency_result_unavailable. Reconcile an unknown outcome with Get project.

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

projectId
string
required

The project ID, as GET /api/v2/projects/get returns it.

Minimum string length: 1

Body

application/json

The ordinary fields to change; omitted fields are unchanged and nothing is cleared. At least one field besides id is required. Unknown fields are refused.

name
string

The project name, stored exactly as sent; it must not be blank.

description
string
startDate
number

When the project starts, epoch milliseconds.

targetDate
number

When the project is due, epoch milliseconds.

purposeStatement
string

Response

Success

data
object
required
meta
object
required