---
title: "Update folder"
method: PATCH
path: "/catalog/v1/folders/{urn}"
tags: ["Folders"]
---

# Update folder

`PATCH /catalog/v1/folders/{urn}`

## Request

- Base URL: `https://your-environment.ataccama.one/api`
- URL: `https://your-environment.ataccama.one/api/catalog/v1/folders/{urn}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/docs/catalog/v1/folders/:urn/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update specific fields of a folder using JSON Merge Patch ([RFC 7396](https://www.rfc-editor.org/rfc/rfc7396.html)). You only need to specify the fields you want to change.

The parent of the folder can't be changed.

## Path parameters

- `urn` string, uri, required: A URN identifying a Folder resource in the Catalog API. Format: urn:ata:{tenant}:catalog:folder:{uuid} Example: urn:ata:acme-corp:catalog:folder:123e4567-e89b-12d3-a456-426614174000.

## Request body

- FolderPatch
  - `name` string: Updated name of the folder.
  - `description` string, nullable: Updated description of the folder.
  - `extraProperties` ExtraProperties: A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays. In responses, only properties explicitly requested via the `extraProperties` query parameter are included. In `PATCH` requests, only the properties listed in the body are modified; set a property to `null` (for scalars) or `[]` (for reference arrays) to clear its value. To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: `catalogItem` for catalog items, `attribute` for catalog attributes, `source` for sources, `folder` for folders, and the term's own `type` (for example, `businessTerm`) for terms.

## Response `200`

Folder updated.

- Folder: A folder in the workspace of a source, organizing the catalog items created in the source rather than imported from it, such as SQL catalog items.
  - `urn` string, uri, required: A URN identifying a Folder resource in the Catalog API. Format: urn:ata:{tenant}:catalog:folder:{uuid} Example: urn:ata:acme-corp:catalog:folder:123e4567-e89b-12d3-a456-426614174000.
  - `name` string, required: Name of the folder.
  - `description` string: Description of the folder.
  - `parentUrn` string, uri, required: URN of the folder's parent. A folder is nested either directly under a source or under another folder, forming a recursive hierarchy. Format: urn:ata:{tenant}:catalog:source:{uuid} or urn:ata:{tenant}:catalog:folder:{uuid} Example values: - urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f - urn:ata:acme-corp:catalog:folder:123e4567-e89b-12d3-a456-426614174000
  - `extraProperties` ExtraProperties: A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays. In responses, only properties explicitly requested via the `extraProperties` query parameter are included. In `PATCH` requests, only the properties listed in the body are modified; set a property to `null` (for scalars) or `[]` (for reference arrays) to clear its value. To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: `catalogItem` for catalog items, `attribute` for catalog attributes, `source` for sources, `folder` for folders, and the term's own `type` (for example, `businessTerm`) for terms.

## Other responses

- `400`: Bad request. The request parameters or body are invalid.
- `403`: Forbidden. You do not have permission to access the requested resource.
- `404`: Not found. The requested resource does not exist.

---

[API](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api.md) - [All operations](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/revisions/46f16e0487f8?raw)