Skip to content
forgit api docs

Update issue type for an organization

PUT
/orgs/{org}/issue-types/{issue_type_id}

Updates an issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
org
required
string

The organization name. The name is not case sensitive.

issue_type_id
required
integer

The unique identifier of the issue type.

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
name
required

Name of the issue type.

string
is_enabled
required

Whether or not the issue type is enabled at the organization level.

boolean
description

Description of the issue type.

string
nullable
color

Color for the issue type.

string
nullable
Allowed values: gray blue green yellow orange red pink purple
Examples
Example default 
{
  "name": "Epic",
  "description": "An issue type for a multi-week tracking of work",
  "is_enabled": true,
  "color": "green"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Issue Type

The type assigned to the issue. This is only present for issues in repositories where issue types are supported.

object
id
required

The unique identifier of the issue type.

integer
node_id
required

The node identifier of the issue type.

string
name
required

The name of the issue type.

string
description
required

The description of the issue type.

string
nullable
color

The color of the issue type.

string
nullable
Allowed values: gray blue green yellow orange red pink purple
created_at

The time the issue type created.

string format: date-time
updated_at

The time the issue type last updated.

string format: date-time
is_enabled

The enabled state of the issue type.

boolean
Examples
Example default 
{
  "id": 410,
  "node_id": "IT_kwDNAd3NAZo",
  "name": "Task",
  "description": "A specific piece of work",
  "created_at": "2024-12-11T14:39:09Z",
  "updated_at": "2024-12-11T14:39:09Z"
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “ 422 ”

Validation failed, or the endpoint has been spammed.

Media type application/json
Validation Error Simple

Validation Error Simple

object
message
required
string
documentation_url
required
string
errors
Array<string>
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    "example"
  ]
}