Update a Project

Update a Project ID with only the fields provided (overwrite)

SecurityJWT or OAuth2 or DeveloperToken
Request
path Parameters
project_id
required
string <uuid>

Project ID

Example: eefb57e0-79f2-4bc7-9b70-99fbc175175c
Request Body schema: application/json

Project to create or update

name
string

Project name

private
boolean

If true, the project is private to the creating user

object (ProjectPreferences)
Responses
200

Project success response

Response Schema: application/json
archive_status
string

Archival status for this Project

Enum: "standard" "archiving" "unarchiving" "archived"
archived_at
string <date-time>

When a Project was archived

archived_file_count
integer
Default: 0
archived_storage
integer
Default: 0
collaborator_count
integer
Default: 0
deleted_at
string <date-time>

If deleted, when this Project was deleted

description
string
file_count
integer
Default: 0
folder_count
integer
Default: 0
id
string <uuid>
ignore_archive
boolean
Default: false
inserted_at
string <date-time>

When was this Project created

invite_url
string
name
string

Name of this Project

owner_id
string <uuid>
private
boolean
Default: false
object (ProjectPreferences)
read_only
boolean
Default: false
object (Asset)
root_asset_id
string <uuid>
shared
boolean
Default: false
storage
integer
Default: 0
object (Team)
team_id
string <uuid>
updated_at
string <date-time>
object (UserPermissions)
object (ProjectPreferences)
object (Watermark)
401

Unauthorized response

404

Not Found response

put/v2/projects/{project_id}
Request samples
application/json
{ }
Response samples
application/json
{
  • "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  • "name": "My Project",
  • "owner_id": "dddddddd-dffd-dddd-dddd-dddddddddddd",
  • "private": false,
  • "project_preferences": { },
  • "root_asset_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
  • "team_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
}