Share Collection Contents

Share the zip file of all accessible Assets in a collection and send to the specified emails in share users list. User can also send the custom share message along with request. \n\nThe user sharing the Assets must be granted the Download and Share Security Template permission on the Assets being shared.

Average Response Time: 49ms

SecurityApiKeyAuth or BasicAuth
Request
path Parameters
id
required
string

Specify Collection ID

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 must be a JSON object.

object (Sender)
Array of objects (Recipient)

A list of email addresses of the recipients.

shareMessage
string

A message from sender to recipient

Responses
200

Successful operation

400

Invalid status value

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden

post/collection/{id}/share
Request samples
application/json
{
  • "sender": {
    },
  • "shareUsers": [
    ],
  • "shareMessage": "A message from sender to recipient"
}
Response samples
application/json
{
  • "StatusCode": 200,
  • "ExecutedVersion": "$LATEST",
  • "Payload": "{\"statusCode\":200,\"body\":\"{\\\"message\\\":\\\"Message sent successfully\\\"}\",\"headers\":{\"content-type\":\"application/json\"}}"
}