About this resource
Representation of a shared download link.
Properties
| Property | Description | Type |
|---|---|---|
| createdOn | Gets the creation datetime in UTC time. | datetime |
| displayName | Gets the human-readable display name of what was shared (e.g. a collection's name), or null when it was not captured at creation time — consumers should fall back to the stored file name. | string |
| downloadCount | Gets the total number of times this shared download link's files have been downloaded. 0 when it has never been downloaded. | int32 |
| expiresOn | Gets the expiration datetime in UTC time. | datetime |
| id | The Id of this shared download link. | guid |
| originType | Gets the kind of DAM entity this link was shared from (ContentItem, Collection, Basket, or Selection), or null when it was not captured at creation time — consumers should fall back to the file-count-derived share type. | string |
| resourcePurgedOn | Gets the datetime in UTC time on which this shared download link's underlying resource was purged, or null when the resource is still present. An expired link can only be reactivated (by changing its expiration date) while its resource has not yet been purged. | datetime |
| revokedOn | Gets the datetime in UTC time on which this shared download link was revoked, or null when the link has not been revoked. A revoked link no longer grants downloads. | datetime |
| sendEmail | Gets whether an e-mail was sent. | boolean |
| useVerification | Gets whether verification is required. | boolean |
Relations
| Method | Name | Select-key | Resource type | Description |
|---|---|---|---|---|
| GET | self | Provides a link to this resource. | ||
| GET | files | select-SharedDownloadLink: files | SharedDownloadLinkFileCollection | Gets the files included in this shared download link. |
| GET | createdby | select-SharedDownloadLink: createdby | User | Gets or sets the user that created this resource. |
Actions
| Method | Action | Description | Response codes |
|---|---|---|---|
| POST /shareddownloadlink/{sharedDownloadLinkId}/requestverificationcode | requestverificationtokenforsharedlink | Request a verification token for downloading a shared download link. | |
| POST /shareddownloadlink/{sharedDownloadLinkId}/revoke | revokesharedlink | Revoke a shared download link. | |
| POST /shareddownloadlink/{sharedDownloadLinkId}/expiration | editsharedlinkexpiration | Change the expiration date of a shared download link. | |
| GET /shareddownloadlink/{sharedDownloadLinkId}/downloads | getdownloadsforsharedlink | Read the download activity of a shared download link. |
Examples
Revoking a shared download link
Revoking a shared download link immediately blocks all downloads through the link and deletes
the underlying stored files. The link itself remains visible in the shared download links
collection with its revokedOn date. Revocation is permanent: a revoked link cannot be
reactivated, and revoking it again returns 400 Bad Request.
POST /shareddownloadlink/0b8b778a41c34a5ba26811d3fa46792e/revoke HTTP/1.1
Only the creator of the link or a member of the Administrators user group can revoke a link;
for any other user this returns 403 Forbidden. Recipients that try to use a revoked link
receive 410 Gone with the message "The shared download link has been revoked." — distinct
from the 403 Forbidden returned for a wrong or expired verification code.
Editing a shared download link's expiration
Changes the expiration date of a shared download link. Setting a valid future date on an
expired link whose resource is still retained reactivates it. The new date must be in the
future and must not push the link's total lifetime beyond its maximum from the original
creation date; otherwise 400 Bad Request is returned.
POST /shareddownloadlink/0b8b778a41c34a5ba26811d3fa46792e/expiration HTTP/1.1
Content-Type: application/json
{ "expiresOn": "2026-09-01T00:00:00Z" }
Only the creator of the link or a member of the Administrators user group can change the
expiration; for any other user this returns 403 Forbidden. A revoked link, or an expired link
whose resource has already been purged, cannot be changed and returns 400 Bad Request.
Reading the download activity of a shared download link
Returns the download-activity events for a shared download link, newest first. Each item
identifies which file was downloaded, which recipient downloaded it, and when. An empty
array is returned when the link has never been downloaded. This is a dedicated read path
alongside (not a replacement for) the write-only audit trail.
GET /shareddownloadlink/0b8b778a41c34a5ba26811d3fa46792e/downloads HTTP/1.1
Only the creator of the link or a member of the Administrators user group can read download
activity; for any other user this returns 403 Forbidden. An unknown link id returns 404 Not Found.