projectTypes

Updates project type.

Changed on

Updates project type. The submitted name, icon, and settings replace the existing values.

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

put/projecttypes/{projectTypeId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/projecttypes/{projectTypeId}
  • Auth: HTTP bearer

Path parameters

projectTypeIdstring uuid required

The id of the project type.

Request body

namestring required

The names of the project type.

descriptionstring nullable

A short description of the project type.

iconstring nullable

The identifier of the project type icon.

Response

OK

idstring uuid

The id of the type.

namestring nullable

The name of the project type.

descriptionstring nullable

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

iconstring nullable

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.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PutProjectTypeById removed and replaced with projectTypes_PutProjectTypeById