---
title: "Rename or re-describe"
method: PATCH
path: "/collections/{id}"
tags: ["Collections"]
---

# Rename or re-describe

`PATCH /collections/{id}`

## Request

- Base URL: `https://yungle.co/api/v1`
- URL: `https://yungle.co/api/v1/collections/{id}`
- Auth: HTTP bearer

Title and description only. Sharing settings are deliberately not writable here. Renaming never changes the URL — it has already been sent to people.

## Request body

- object
  - `title` string
  - `description` string

## Response `200`

The updated collection.

- object
  - `collection` Collection, required
    - `id` string, required
    - `title` string, required
    - `slug` string, required
    - `description` string, nullable, required
    - `visibility` string, required: Currently one of: `private`, `public`, `password`. Treat unknown values as unknown, not as an error.
    - `url` string, uri, nullable, required: The secret link. Treat it like a password.
    - `customLink` boolean, required: Whether the readable `<your-domain>/<slug>` address is on.
    - `sizeBytes` integer, required
    - `fileCount` integer: Present on the single-collection read.
    - `coverFileId` string, nullable, required
    - `expiresAt` string, date-time, nullable, required: Null on a paid plan: nothing expires.
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `400`: The request was malformed or failed validation. Codes: `invalid_request`, `folder_error`.
- `401`: Missing or invalid credential. Codes: `unauthorized`.
- `402`: Needs a paid plan, or prepaid credit for metered usage. Codes: `upgrade_required`, `out_of_credit`.
- `403`: The credential lacks a required scope, or a shared link refused access. Codes: `insufficient_scope`, `password_required`, `wrong_password`, `guests_only`.
- `404`: No such resource in this workspace. Codes: `not_found`.
- `429`: Rate limit or email budget exhausted. Wait for `Retry-After`. Codes: `rate_limited`, `email_budget_exhausted`.
- `500`: Our fault. `details.requestId` ties it to our logs. Codes: `internal_error`.

---

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