---
title: "Share a DMS resource with the current client"
method: POST
path: "/internal/api/clients/{client_id}/dms/shares"
tags: ["CLIENT", "Client Document Management", "DMS Shares"]
---

# Share a DMS resource with the current client

`POST /internal/api/clients/{client_id}/dms/shares`

## Request

- Base URL: `https://api.signalshq.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.signalshq.io/internal/api/clients/{client_id}/dms/shares`
- Auth: OAuth 2
  - Password
  - Token URL: `/auth/login`

Share a folder or document with the client identified by the URL path. The recipient email is resolved internally — never supplied by the caller. Idempotent: returns the existing share if one already exists.

## Path parameters

- `client_id` string, uuid, required: Client ID

## Request body

- DMSShareCreateRequest: Request body for sharing a DMS resource with the client in the URL path.
  - `resource_type` 'FOLDER' | 'DOCUMENT', required
  - `resource_id` string, uuid, required: UUID of the folder or document to share

## Response `201`

Successful Response

- DMSShareResponse: Response returned to CPA after creating or fetching a share.
  - `id` string, uuid, required: Unique share record ID
  - `resource_type` 'FOLDER' | 'DOCUMENT', required
  - `resource_id` string, uuid, required: UUID of the shared resource
  - `client_id` string, uuid, required: UUID of the client this resource is shared with
  - `shared_with_email` string, nullable: Email of the recipient — resolved internally from TenantClient.email at creation time. Never accepted as API input.
  - `shared_by` string, required: CPA user ID who created the share
  - `is_active` boolean, required: Whether the share is currently active
  - `created_at` string, date-time, required: Timestamp when the share was created
  - `revoked_at` string, date-time, nullable: Timestamp when the share was revoked, if applicable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/signalshq/apis/signals-api.md) - [All operations](https://skmtc.dev/signalshq/apis/signals-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signalshq/apis/signals-api/revisions/2c22af3b5576?raw)
