Creates a shareable link for an asset.

Behavior: Generates a shareable URL for the specified asset based on the sharing configuration provided. Options include expiration time, password protection, and access permissions. The generated link can be distributed to external recipients.

Authorization: Requires a valid Bearer token.

Side Effects: A share record is created. Depending on configuration, notification emails may be sent to specified recipients.

Error Scenarios: Returns 400 if the request body is missing. Returns 401 if the caller is not authenticated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the asset to share.

Body Params

The sharing configuration including recipients, expiration, and permissions.

Represents a share configuration that defines how assets are shared with other users, including permissions, duration, and access link.

uuid | null

Gets or sets the unique identifier of the share; if null, a new share will be created.

string | null

Gets or sets the display name of the share.

sharedContents
array of uuids | null

Gets or sets the list of content identifiers included in this share.

sharedContents
sharedDuration
object | null

Gets or sets the duration setting that controls how long the share remains active.

sharedPermissions
array of objects | null

Gets or sets the list of permission levels granted to recipients of this share.

sharedPermissions
sharedType
object | null

Gets or sets the type of share (e.g., link-based, user-based).

sharedStatus
object | null

Gets or sets the current status of the share.

int32 | null

Gets or sets the duration of the share in hours.

string | null
uuid | null

Gets or sets the identifier of the user who owns this share.

date-time | null

Gets or sets the date and time when this share expires and is no longer accessible.

uuid

Gets or sets the asset identifier for internal user-to-user sharing.

nomadUsers
array of objects | null

Gets or sets the list of platform users who have been granted access to the shared content.

nomadUsers
Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json