API v1 ReferenceProject Types

Updates an existing project type.

<Check title="Required Permissions" icon="key">The user must be an admin or have `project-manage-config:write` permissions.</Check>

Authentication

AuthorizationBearer

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

Path parameters

projectTypeIdstringRequiredformat: "uuid"
The id of the project type.

Request

The model to update the project type.
namestringRequired0-255 characters
The names of the project type.
descriptionstring or nullOptional0-1000 characters
A short description of the project type.
iconstring or nullOptional0-25 characters
The identifier of the project type icon.

Response

OK
idstringformat: "uuid"
The id of the type.
namestring or null
The name of the project type.
descriptionstring or null

A short (max. 140 characters) description of the project type.

iconstring or null
The identifier of the project type icon.
isArchivedboolean
Whether this type is archived. It can no longer be used to create projects, but existing projects will continue using it.
isPresetboolean
Whether this type is one of the preset types. Preset types cannot be edited.
createdOndatetime
The date this entity was created.
createdBystringformat: "uuid"
The id of the user who created this entity.
updatedOndatetime
The date this entity was last modified.
updatedBystringformat: "uuid"
The id of the user who last modified this entity.

Errors

400
Bad Request Error
404
Not Found Error