---
title: "Change name, slug, description, visibility, or the site time zone"
method: PATCH
path: "/v1/collections/{collectionId}"
tags: ["Collections"]
---

# Change name, slug, description, visibility, or the site time zone

`PATCH /v1/collections/{collectionId}`

## Request

- Base URL: `https://api.dropl.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.dropl.io/v1/collections/{collectionId}`
- Auth: HTTP bearer

Requires the `collections:schema` scope (create collections and change their fields (structure)).

## Path parameters

- `collectionId` string, uuid, required

## Request body

- UpdateCollectionRequest
  - `name` string
  - `slug` string
  - `description` string, nullable
  - `visibility` 'public' | 'private'
  - `timezone` string: IANA zone of the whole client site, e.g. America/Chicago.

## Response `200`

Success

- CollectionDetail
  - `id` string, uuid, required
  - `publicId` string, required
  - `workspaceId` string, uuid, required
  - `name` string, required
  - `slug` string, required
  - `description` string, nullable, required
  - `templateKey` 'menu' | 'inventory' | 'events', nullable, required
  - `visibility` 'public' | 'private', required
  - `itemCount` integer, required
  - `publishedItemCount` integer, required
  - `titleFieldKey` string, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `deletedAt` string, date-time, nullable, required
  - `purgeAfter` string, date-time, nullable, required
  - `lastPublicReadAt` string, date-time, nullable, required
  - `fields` CollectionField[], required
    - `key` string: Stable; websites read values by it. Omit on new fields to derive it from the label.
    - `label` string, required
    - `type` 'short_text' | 'long_text' | 'number' | 'price' | 'date' | 'datetime' | 'toggle' | 'select' | 'multi_select' | 'image' | 'images' | 'link', required
    - `required` boolean
    - `helpText` string, nullable
    - `options` CollectionFieldOption[], nullable
      - `value` string, required
      - `label` string, required
    - `currency` string, nullable
    - `min` number, nullable
    - `max` number, nullable
  - `schemaVersion` integer, required
  - `timezone` string, required
  - `publicItemsUrl` string, uri, nullable, required: Public read endpoint for websites (published items only); null when private.
  - `canEditSchema` boolean, required
  - `limits` CollectionLimits, required
    - `accountItemsUsed` integer, required
    - `accountItemLimit` integer, nullable, required
    - `itemsPerCollectionLimit` integer, required
    - `collectionsPerSiteLimit` integer, nullable, required
    - `siteCollectionsUsed` integer, nullable, required

## Other responses

- `400`: Validation failed
- `401`: `INVALID_API_KEY`: missing, invalid, expired, or revoked key
- `403`: `INSUFFICIENT_SCOPE` (names the missing scope), `SITE_RESTRICTED_KEY`, or a plan limit
- `404`: Not found, or outside the key's sites
- `429`: Rate limited

---

[API](https://skmtc.dev/dropl/apis/dropl-public-api.md) · [All operations](https://skmtc.dev/dropl/apis/dropl-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dropl/apis/dropl-public-api/revisions/8a42e1f968d4?raw)