Sign in

Generate Share Links

Generates one or multiple share links based on person IDs and folder names.

Logic:

  • Person images: images where image_faces.person_id matches
  • folderNames: tag values (uncategorized folders, brands, custom options — not only project_folders). Images: tagged with that name AND "Highlights" (general). Locked tags on images are excluded on the share page/download unless unlocked for that link (sharelink_unlocked_tags).
  • Final set: personMedia ∪ tagMedia (deduplicated)

If mode="per_person": creates one share per personId with label=person.name If mode="all_in_one": creates one share with all selected persons + folders If no people and customTagLinkMode="per_option" with 2+ custom tag options selected: one share per option; each share includes the same folders/brands plus that option. Labels use labelStrategyCustomFolder (e.g. category_option → "Category - Option").

post/shares/generate

Request body

projectIdinteger required
personIdsstring[]
mode'per_person' | 'all_in_one'
folderNamesstring[]
folderCategoriesobject
expiresInDaysinteger nullable
passwordstring nullable
creatorDisplaystring nullable
labelStrategyPeople'name_only' | 'category_name' | 'name_category' nullable
labelStrategyBrands'name_only' | 'brand_prefix' nullable
labelStrategyCustomFolder'name_only' | 'category_option' nullable
categorystring nullable
linkLabelstring nullable
customTagLinkMode'combined' | 'per_option' nullable

Response

Successful Response

{"stackTrail":"paths:/shares/generate:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

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