Update Share

Update a share (requires FULL_ACCESS on the resource)

put/shares/{share_id}

Request

Base URL
https://api.aspect.inc
URL
https://api.aspect.inc/shares/{share_id}
Auth
API key in header Authorization

Path parameters

share_idstring uuid required

Share id

Request body

namestring nullable

New name for the share

actionsinteger nullable

New actions bitmap

is_activeboolean nullable

Whether the share is active

passwordstring nullable

New password. Omit to keep the current value.

clear_passwordboolean nullable

Set to true to remove password

expires_atstring date-time nullable

New expiration. Omit to keep the current value.

clear_expires_atboolean nullable

Set to true to remove expiration

watermark_idstring uuid nullable

Watermark configuration to apply to share viewers

clear_watermarkboolean nullable

Set to true to remove watermark from share

visible_metadata_attribute_idsstring[] nullable

Metadata attribute IDs share users can see, everything else is hidden (empty array clears)

Response

Successful Response

idstring uuid required

Share ID (used in URLs)

resource_idstring uuid required

Resource being shared

Types of resources in the hierarchy.

resource_namestring required

Name of the resource

created_by_user_idstring uuid nullable

User who created the share. Null when that account has been deleted

namestring nullable

Share name

actionsinteger required

Allowed actions bitmap

has_passwordboolean required

Whether share is password protected

expires_atstring date-time nullable

Expiration timestamp

is_activeboolean required

Whether the share is active

watermark_idstring uuid nullable

Watermark configuration applied to share viewers

visible_metadata_attribute_idsstring[] nullable

Metadata attribute IDs share users can see

createdstring date-time required

Creation timestamp

updatedstring date-time required

Last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.