API ReferenceAssets

Share an asset with users

Beta

Share an asset with specific users by email. Only users who have edit access to the asset can share it. You can share with individual users (granting ‘view’ or ‘edit’ permission). Sharing with a user who does not have an account will result in an error for that recipient, but other recipients will still be processed.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

asset_idstringRequired
Unique identifier of the asset to share

Request

This endpoint expects an object.
recipientslist of objectsRequired
List of users to share the asset with. Each entry specifies an email address and the permission level to grant.
include_folder_contentsboolean or nullOptional

Controls child-sharing when sharing a container asset (folder, collection, or project). true: also share the container’s children owned by the current user. false: container only, skip children. null (default): folders share all accessible children; collections and projects are container-only (their cascade is opt-in via true).

messagestring or nullOptional<=2000 characters

Optional personal message to include in the notification email (max 2000 characters)

notifybooleanOptionalDefaults to true
Whether to send email notifications to recipients

Response

Asset sharing processed successfully
asset_idstring
ID of the shared asset
recipients_resultlist of objects
Results for each recipient that was shared with

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error