Clatter Labs
Console

Code Buckets

Update a project

View as Markdown

Rename a project or change its description.

PATCHapi.codebuckets.clatterlabs.xyz/v1/projects/{project_id}buckets:write

Changes only the fields you send. The Project ID never changes. Recorded as a project.updated event.

Authorizations

Authorizationstringrequired

Your API key as a bearer token: Bearer clsk_.... Create keys in the Console with the Code Buckets permissions you need.

X-Clatter-Accountstringrequired

The Account ID that owns the key, like CL-7K2M9QXA. Find it in Console › Settings. A missing value answers 401 missing_account_id; someone else's answers 401 account_mismatch.

Path parameters

project_idstringrequired

The Project ID (cbp_…).

Body

application/json

namestring

Up to 80 characters.

descriptionstring | null

Up to 500 characters; send null to clear it.

Response

200 · application/json

objectstring

Always project.

idstring

The Project ID, like cbp_4k9x2m7q1n8v3c6z0b5w. Stable for the life of the project.

project_idstring

Same as id, for convenience.

namestring

The project's name.

descriptionstring | null

Your description.

bucketsinteger

How many buckets the project has.

created_at / updated_atstring

ISO 8601 timestamps.

Errors

StatusCodeWhen
401invalid_api_key / missing_account_id / account_mismatchThe key or Account ID is wrong.
402quota_exceededThis month's free tokens are used up.
403insufficient_scopeThe key lacks the permission.
404not_foundNo project with that id on your account.
curl -X PATCH "https://api.codebuckets.clatterlabs.xyz/v1/projects/PROJECT_ID" \
  -H "Authorization: Bearer $CLATTER_API_KEY" \
  -H "X-Clatter-Account: $CLATTER_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "storefront-v2"
  }'
import os
import requests

headers = {
    "Authorization": f"Bearer {os.environ['CLATTER_API_KEY']}",
    "X-Clatter-Account": os.environ["CLATTER_ACCOUNT_ID"],
}

r = requests.patch(
    "https://api.codebuckets.clatterlabs.xyz/v1/projects/PROJECT_ID",
    headers=headers,
    json={
        "name": "storefront-v2"
    },
)
print(r.json())
const headers = {
  Authorization: `Bearer ${process.env.CLATTER_API_KEY}`,
  "X-Clatter-Account": process.env.CLATTER_ACCOUNT_ID,
  "Content-Type": "application/json",
};

const res = await fetch("https://api.codebuckets.clatterlabs.xyz/v1/projects/PROJECT_ID", {
  method: "PATCH",
  headers,
  body: JSON.stringify({
    "name": "storefront-v2"
  }),
});
console.log(await res.json());
{
  "object": "project",
  "id": "cbp_4k9x2m7q1n8v3c6z0b5w",
  "project_id": "cbp_4k9x2m7q1n8v3c6z0b5w",
  "name": "storefront-v2",
  "description": "Web shop and its assets",
  "buckets": 1,
  "created_at": "2026-10-28T14:05:11.482Z",
  "updated_at": "2026-10-28T14:05:11.482Z"
}