---
title: "Update collection metadata"
method: PUT
path: "/_fabric/{fabric}/_api/collection/{collection-name}/metadata"
tags: ["Collections"]
---

# Update collection metadata

`PUT /_fabric/{fabric}/_api/collection/{collection-name}/metadata`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/collection/:collection-name/metadata/put.ts> (a function with typed inputs; its response is checked against the schema)

Update metadata related to the collection.

## Request body

- object
  - `workflows` WorkflowMetadataEntity[]
    - `uuid` string: Unique identifier of the workflow. This is represented as a UUID.
    - `sourceConnection` WorkflowConnectionEntity
      - `name` string: Connection name for the workflow.
      - `dynamicConfigs` object: Dynamic configurations of the connection.
      - `connector` ConnectorBase: Lightweight connector definition.
        - `name` string: Name of the connector. This is used as the ID of the connector.
        - `displayName` string: Name that can be used by GUI clients to display the connector.
        - `description` string
        - `type` string: Specifies whether the connector serves as a source or a target.
        - `version` string: Version of the connector.
      - `isEditable` boolean: Whether this connection is editable or not.
      - `isInternal` boolean: Whether this connection is internal or not.
    - `targetConnection` WorkflowConnectionEntity
      - `name` string: Connection name for the workflow.
      - `dynamicConfigs` object: Dynamic configurations of the connection.
      - `connector` ConnectorBase: Lightweight connector definition.
        - `name` string: Name of the connector. This is used as the ID of the connector.
        - `displayName` string: Name that can be used by GUI clients to display the connector.
        - `description` string
        - `type` string: Specifies whether the connector serves as a source or a target.
        - `version` string: Version of the connector.
      - `isEditable` boolean: Whether this connection is editable or not.
      - `isInternal` boolean: Whether this connection is internal or not.
    - `transformation` string: Complete stream worker for the transformation.

## Response `200`

Successfully updated metadata of the collection.

- object
  - `error` boolean, required
  - `code` integer
  - `result` object
    - `_key` string
    - `_rev` string

## Other responses

- `400`: Failed due to missing or malformed data. Verify that all parameters are complete.
- `401`: Failed to authenticate the request.
- `404`: Failed to find the metadata entry for the collection.

---

[API](https://skmtc.dev/macrometa/apis/macrometa-api-reference.md) - [All operations](https://skmtc.dev/macrometa/apis/macrometa-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/macrometa/apis/macrometa-api-reference/revisions/2006b6d7f31d?raw)