Share a selection of Assets.

Share a selection of Assets to a user specified by Email address.

The user sharing the Assets must be granted the Download Security Template permission on the Assets being shared.

SecurityApiKeyAuth or BasicAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

The Request Body is a JSON object

object (AssetShareSender)

Sender information to use in the email

Array of objects (AssetShareRecipient)

A list of users to share assets with

assets
Array of strings <uuid>

List of Asset object IDs to be shared

shareMessage
string

An email message.

Responses
200

Successful operation

403

Forbidden

post/asset/share
Request samples
application/json
{
  • "sender": {
    },
  • "shareUsers": [
    ],
  • "assets": [
    ],
  • "shareMessage": "A message from sender to recipient"
}
Response samples
application/json
{
  • "message": "Message sent successfully"
}