---
title: "Preview Share"
method: POST
path: "/shares/preview"
---

# Preview Share

`POST /shares/preview`

## Request

- Base URL: `https://api.pavoot.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pavoot.com/shares/preview`
- Auth: none declared

Live preview for the create/edit builder: resolves the exact set of images a link WOULD
contain (scope resolved within its project + individual images cross-project), returning the
total count and a handful of thumbnails. No link is created.

## Request body

- SharePreviewRequest
  - `projectId` integer, nullable
  - `imageIds` string[]
  - `personIds` string[]
  - `personFieldValueIds` string[]
  - `folderNames` string[]
  - `folderCategories` object
  - `folderRefs` ShareFolderRefRequest[]
    - `name` string, required
    - `category` string, nullable
  - `allProjectImages` boolean
  - `scopeMatch` 'any' | 'all', nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-23** `1e48db8026da`: 2 info
  - added the new optional request property `allProjectImages`
  - added the new optional request property `scopeMatch`

[Operation history](https://skmtc.dev/pavoot/apis/pavoot-api/changes/shares/preview/post.md)

---

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