Skip to main content
PATCH
/
v1
/
projects
/
{id}
Update a project (rename or adjust retention override)
curl --request PATCH \
  --url https://api.trulayer.ai/v1/projects/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "retention_days_override": 2
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "retention_days_override": 2
}

Documentation Index

Fetch the complete documentation index at: https://docs.trulayer.ai/llms.txt

Use this file to discover all available pages before exploring further.

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