Create Thread Share

Create a new thread share for a thread (owner only).

Fails with 409 if an active share already exists for this thread —
use PUT to update it instead.

Path Parameters:

thread_id (int): The ID of the chat thread to share.

Request Body:

access_level (str): Required. Must be "PUBLIC" or "INVITE_ONLY".

consent_given (bool): Required. Must be true to confirm user consent for sharing.

expiry_date (str): Optional. ISO 8601 datetime for share expiration.

user_permissions (dict): Optional. Dict of email -> permissions (["view"] or
["view", "write"]). Required for INVITE_ONLY shares.

public_can_write (bool): Optional. For PUBLIC shares: allow write/fork access.
Default: false.

Returns:

A response containing the created share in data, including invite_results[]
(per-recipient invite outcome) for INVITE_ONLY shares.

Response Headers:

X-Authorization-Consistency-Token (string): SpiceDB consistency token from the
write. Echo it back on subsequent reads for read-after-write consistency.

Current Version:

2.0.0

curl --location --globoff 'https:///api/v2/chat-threads//shares' \ --header 'Ocp-Apim-Subscription-Key: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "access_level": "PUBLIC", "consent_given": true, "expiry_date": "2026-12-31T23:59:59Z", "user_permissions": {}, "public_can_write": false }'

{ "success": true, "message": "Share created successfully. 2 user(s) invited", "data": { "id": 123, "share_token": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "access_level": "INVITE_ONLY", "status": "ACTIVE", "expiry_date": "2026-12-31T23:59:59Z", "consent_given": true, "snapshot_created_at": "2026-01-06T12:30:00Z", "agent": 5, "chat_thread": 42, "is_expired": false, "is_accessible": true, "user": 1, "created_by": "[email protected]", "modified_by": "[email protected]", "created_on": "2026-01-06T12:30:00Z", "modified_on": "2026-01-06T12:30:00Z", "invite_results": [ { "email": "[email protected]", "success": true, "message": "Invited successfully" }, { "email": "[email protected]", "success": true, "message": "Invited successfully" } ] } }

Request

Responses