Projects

Update Project

Update a project

put/projects/{project_id}

Request

  • Base URL
    https://api.aspect.inc
  • URL
    https://api.aspect.inc/projects/{project_id}
  • Auth
    API key in header Authorization

Path parameters

project_idstring uuid required

Request body

namestring nullable

New name for the project

default_role'full_access' | 'editor' | 'commenter' | 'downloader' | 'viewer' | 'no_access'

Role on a project.

is_activeboolean nullable

New active status for the project (requires workspace admin access). Inactive projects are hidden from listing and discovery surfaces.

Response

Successful Response

idstring uuid required

Project ID

namestring required

Project name

root_directory_idstring uuid required

The project's top-level directory. Use it as parent_id to list the project's contents.

trash_directory_idstring uuid required

Trash directory ID - deleted assets are moved here

default_role'full_access' | 'editor' | 'commenter' | 'downloader' | 'viewer' | 'no_access' required

Role on a project.

is_activeboolean required

Whether the project is active. Inactive projects are hidden from listing and discovery surfaces.

num_assetsinteger required

Number of assets in project

size_bytesinteger required

Total size of assets in bytes

durationnumber required

Total duration in seconds

created_by_user_idstring uuid required

ID of the user that created the project

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.