v1

latestOpenAPI 3.1.02026-07-24440202.2 KB

Generate a public Share link

Generate a link to share one or more assets

post/createsharelink_41M9_V1

Request body

titlestring

The name of the share. For example, “Spring collection photoshoot.”

descriptionstring

A description of the share. For example, “Photos and video for review.”

assetIDsstring[] required

The unique <a href="https://developer.orangelogic.com/reference/assets#record-id">IDs</a> of the assets included in the share.

expirationDatestring required

The expiration date of the share, entered as a <a href="https://developer.orangelogic.com/reference/date-and-time">yyyy-mm-ddThh:mm:ss string</a>.

imageFormatstring

The <a href="https://developer.orangelogic.com/reference/assets#formats">format</a> used for all image assets included in the share. You can specify only one image format for a share.

audioFormatstring

The <a href="https://developer.orangelogic.com/reference/assets#formats">format</a> used for all audio assets included in the share. You can specify only one audio format for a share.

videoFormatstring

The <a href="https://developer.orangelogic.com/reference/assets#formats">format</a> used for all video assets included in the share. You can specify only one video format for a share.

containerFormat'Small' | 'Medium' | 'Large' | 'Original'

The <a href="https://developer.orangelogic.com/reference/generate-public-share-links">view permissions</a> granted to the link recipient for all containers included in the share. Recipients must have at least View Small permission to see assets. When you choose a format other than small, recipients can access all proxy formats at the level you select and smaller.

watermarkPresetstring

The <a href="https://developer.orangelogic.com/reference/retrieve-watermark-presets-to-use-in-a-public-share-link">watermark</a> applied to all assets included in the share. When this parameter is blank, no watermark is applied.

includeNonWatermarkableAssetsboolean

When <code>true</code>, assets that cannot be watermarked (such as folders) are included in the share.

allowDownloadboolean

When <code>true</code>, recipients can download the shared assets. This permission is granted even if the recipient wouldn’t otherwise be able to download the asset.

allowFindboolean

When <code>true</code>, recipients with Orange Logic accounts can see the shared assets in the search results. This permission is granted even if the recipient wouldn’t otherwise be able to find the asset.

allowEditboolean

When <code>true</code>, recipients can edit the shared assets’ metadata. This permission is granted even if the recipient wouldn’t otherwise be able to edit the asset.

disableMetadataLinkboolean

<ul><li>When <code>true</code>, no links are included in asset metadata.</li><li>When <code>false</code>, asset metadata that is configured to be displayed as clickable links is included with active links. For example, if asset tags are shown as links, users with Orange Logic accounts can click a tag to see all the assets that share that tag.</li></ul>

Response

200

statusstring

{"stackTrail":"paths:/createsharelink_41M9_V1:post:responses:200:content:application/json:schema:properties:shareLink","oasType":"schema","type":"unknown"}

accessKeystring

messagestring

{"stackTrail":"paths:/createsharelink_41M9_V1:post:responses:200:content:application/json:schema:properties:errors","oasType":"schema","type":"unknown"}

Example response

{
  "status": "Processing",
  "accessKey": "8u0bh6i670eict5wu8iw6jt60nlyfj7a",
  "message": "Link is being generated. Please check back later.\nUnsupported options: AllowFind,AllowEdit. Please contact administrator to enable."
}