Skip to main content
PATCH
Update a project (rename or adjust retention override)

Authorizations

Authorization
string
header
required

SDK API key (tl_...) or Clerk session JWT

Path Parameters

id
string<uuid>
required

Body

application/json

Partial update payload for PATCH /v1/projects/{id}. Omit a field to leave it unchanged. Supply retention_days_override: null to clear the override back to the plan default.

name
string
Required string length: 1 - 100
retention_days_override
integer | null

Per-project retention window in days. Must be between 1 and the caller's plan retention cap. Pass null to clear.

Required range: x >= 1

Response

Project updated

id
string<uuid>
required
organization_id
string<uuid>
required
name
string
required
slug
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
archived_at
string<date-time> | null
retention_days_override
integer | null

Per-project retention override (TRU-170). When null, retention follows the plan default; when set, must be between 1 and the plan's RetentionDays cap (unbounded on Enterprise).

Required range: x >= 1