---
title: "Shares a collection to a user."
method: PUT
path: "/collections/{collection_id}/permissions/{username}"
tags: ["Collections"]
---

# Shares a collection to a user.

`PUT /collections/{collection_id}/permissions/{username}`

## Request

- Base URL: `https://h2ogpte.genai.h2o.ai/api/v1`
- URL: `https://h2ogpte.genai.h2o.ai/api/v1/collections/{collection_id}/permissions/{username}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/collections/:collection_id/permissions/:username/put.ts> (a function with typed inputs; its response is checked against the schema)

Shares a collection template to a user.

## Path parameters

- `collection_id` string, required
- `username` string, required

## Request body

- ShareCollectionRequest
  - `permissions` string[]: Individual permission levels defining the sharing rule.

## Response `204`

Successful operation

## Other responses

- `400`: Bad request
- `401`: Unauthorized - Invalid or missing API key
- `409`: Conflict
- `default`: Unexpected error

## Changes

- **2026-11-06** `a82a117320f4`: 4 info
  - added the non-success response with the status `400`
  - added the optional property `error_type` to the response with the `401` status
  - added the optional property `error_type` to the response with the `409` status
  - added the optional property `error_type` to the response with the `default` status

[Operation history](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/changes/collections/:collection_id/permissions/:username/put.md)

---

[API](https://skmtc.dev/h2o/apis/h2ogpte-rest-api.md) - [All operations](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/revisions/a82a117320f4?raw)