Skip to navigation
API ReferenceReview Links

Update a Review Link

Update a Review Links manifest, overwriting any specified key/value pairs

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

Request

ReviewLink to update
namestringRequired
Name of the Review Link
access_controlobjectOptional
allow_approvalsbooleanOptionalDefaults to true

Enable/disable changing an Asset's status by non-Collaborator/Team Members via the Review Link.

current_version_onlybooleanOptionalDefaults to false

Show only the most recent version of Assets in the Review Link

enable_downloadingbooleanOptional
Enable or disable downloading on this Review Link. The default depends on whether the auth used to create this review link allows for this or not.
enable_commentsbooleanOptionalDefaults to true
is_activebooleanOptionalDefaults to true

Disable an Review Link by switching this from true -> false, and vice-versa.

passwordstringOptional

Actually a passphrase, this is an additional security measure for a second layer of security on your Review Links.

Supports alphanumeric input.

ownerobjectOptional
User model
projectobjectOptional
teamobjectOptional
watermark_user_inputstringOptional

Response

ReviewLink success response
namestring
Name of the Review Link
access_controlobjectOptional
available_featuresobjectOptionalRead-only
allow_approvalsbooleanOptionalDefaults to true

Enable/disable changing an Asset's status by non-Collaborator/Team Members via the Review Link.

current_version_onlybooleanOptionalDefaults to false

Show only the most recent version of Assets in the Review Link

deleted_atstringOptionalRead-onlyformat: "date-time"
Deletion time of the Review Link
enable_downloadingbooleanOptional
Enable or disable downloading on this Review Link. The default depends on whether the auth used to create this review link allows for this or not.
expires_atstringOptionalRead-onlyformat: "date-time"
Expiration time of the Review Link
enable_commentsbooleanOptionalDefaults to true
folder_item_countintegerOptionalRead-onlyDefaults to 0
is_activebooleanOptionalDefaults to true

Disable an Review Link by switching this from true -> false, and vice-versa.

notify_on_viewbooleanOptionalRead-onlyDefaults to true
passwordstringOptional

Actually a passphrase, this is an additional security measure for a second layer of security on your Review Links.

Supports alphanumeric input.

has_passwordbooleanOptionalRead-onlyDefaults to false
If false, the Review Link has no passphrase
idstringOptionalRead-onlyformat: "uuid"
UUID of the Review Link
inserted_atstringOptionalRead-onlyformat: "date-time"
item_countintegerOptionalRead-onlyDefaults to 0
Number of items included at the root of the Review Link
itemslist of objectsOptionalRead-only
owner_idstringOptionalRead-onlyformat: "uuid"
project_idstringOptionalRead-onlyformat: "uuid"
reviewer_countintegerOptionalRead-onlyDefaults to 0
short_urlstringOptionalRead-only
ownerobjectOptional
User model
projectobjectOptional
teamobjectOptional
updated_atstringOptionalRead-onlyformat: "date-time"
view_countintegerOptionalRead-onlyDefaults to 0
watermark_user_inputstringOptional
bundle_countintegerOptionalRead-onlyDefaults to 0Deprecated
is_autoplaybooleanOptionalRead-onlyDefaults to falseDeprecated

Errors

401
Unauthorized Error
404
Not Found Error