Limai Docs
API ReferenceBuckets

Update Bucket

Update bucket name or description

PATCH/api/v1/buckets/{bucketId}

Updates the name and/or description of a bucket.

Parameters

NameTypeInRequiredDescription
bucketIdstringpathYesThe bucket ID
namestringbodyNoNew bucket name
descriptionstringbodyNoNew bucket description

Request

const res = await fetch(
"https://app.limai.io/api/v1/buckets/bkt_abc123",
{
  method: "PATCH",
  headers: {
    Authorization: "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Processed Invoices",
    description: "Invoices ready for extraction",
  }),
}
);

Response

Response200
{
  "id": "bkt_abc123",
  "name": "Processed Invoices",
  "description": "Invoices ready for extraction",
  "projectId": "proj_001",
  "fileCount": 42,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-15T12:00:00.000Z"
}