Skip to navigation

Update Project

Update Project.

Authentication

AuthorizationBearer

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

Path parameters

project_idstringRequired
ID of the Project.

Request

This endpoint expects an object.
archiveReasonstringOptional

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedbooleanOptional

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

descriptionstring or nullOptional
hideParentFolderNamesForSharedItemsbooleanOptional
lockSequencesbooleanOptional
namestringOptional
ownerIdstringOptional
publicbooleanOptional
reasonForChangeobjectOptional

Reason for change applied to the entire request. Only relevant to tenants with Data Modifications enabled, where it may be required to update or delete items and is validated against the tenant’s configured reasons. Tenants without Data Modifications enabled can omit it; if supplied, it is not validated.

Response

OK
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
createdAtstring or nullOptionalformat: "datetime"
descriptionstring or nullOptional
hideParentFolderNamesForSharedItemsbooleanOptional
idstringOptional
isDataModsEnabledboolean or nullOptional
lockSequencesbooleanOptional
modifiedAtstring or nullOptionalformat: "datetime"
namestring or nullOptional
ownerobject or nullOptional
publicbooleanOptional
reviewProcessesstringOptionalformat: "uri"

Review processes (a.k.a. review lifecycles) configured for this project.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error