SIsignalshq
CLIENT
Client Document Management
DMS Shares

Share a DMS resource with the current client

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.

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)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

client_idstring uuid required

Client ID

Request body

resource_type'FOLDER' | 'DOCUMENT' required
resource_idstring uuid required

UUID of the folder or document to share

Response

Successful Response

idstring uuid required

Unique share record ID

resource_type'FOLDER' | 'DOCUMENT' required
resource_idstring uuid required

UUID of the shared resource

client_idstring uuid required

UUID of the client this resource is shared with

shared_with_emailstring nullable

Email of the recipient — resolved internally from TenantClient.email at creation time. Never accepted as API input.

shared_bystring required

CPA user ID who created the share

is_activeboolean required

Whether the share is currently active

created_atstring date-time required

Timestamp when the share was created

revoked_atstring date-time nullable

Timestamp when the share was revoked, if applicable

Changes

No recorded changes to this operation across all 1 revision of this API.