---
title: "Create Share"
method: POST
path: "/shares"
tags: ["Shares"]
---

# Create Share

`POST /shares`

## Request

- Base URL: `https://api.aspect.inc`
- URL: `https://api.aspect.inc/shares`
- Auth: API key in header `Authorization`

Create a new share for a resource (requires FULL_ACCESS)

## Request body

- ShareCreateRequest: API request schema for creating a share
  - `resource_id` string, uuid, required: Resource being shared
  - `name` string, nullable: User-friendly name for the share
  - `actions` integer, required: Bitmap of allowed actions (VIEW=1, EDIT=2)
  - `password` string, nullable: Optional password for share protection
  - `expires_at` string, date-time, nullable: Optional expiration timestamp
  - `watermark_id` string, uuid, nullable: Watermark configuration to apply to share viewers
  - `visible_metadata_attribute_ids` string[], nullable: Metadata attribute IDs share users can see (everything else is hidden)

## Response `201`

Successful Response

- ShareResponse: API response schema for a share
  - `id` string, uuid, required: Share ID (used in URLs)
  - `resource_id` string, uuid, required: Resource being shared
  - `resource_type` 'workspace' | 'project' | 'directory' | 'asset' | 'symlink' | 'collection' | 'canvas', required: Types of resources in the hierarchy.
  - `resource_name` string, required: Name of the resource
  - `created_by_user_id` string, uuid, nullable: User who created the share. Null when that account has been deleted
  - `name` string, nullable: Share name
  - `actions` integer, required: Allowed actions bitmap
  - `has_password` boolean, required: Whether share is password protected
  - `expires_at` string, date-time, nullable: Expiration timestamp
  - `is_active` boolean, required: Whether the share is active
  - `watermark_id` string, uuid, nullable: Watermark configuration applied to share viewers
  - `visible_metadata_attribute_ids` string[], nullable: Metadata attribute IDs share users can see
  - `created` string, date-time, required: Creation timestamp
  - `updated` string, date-time, required: Last update timestamp

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/aspect/apis/aspect-api.md) - [All operations](https://skmtc.dev/aspect/apis/aspect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aspect/apis/aspect-api/revisions/28ea5f1adb54?raw)