orgs

Create issue field for an organization

Changed on

Creates a new issue field for an organization.

You can find out more about issue fields in Managing issue fields 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.

post/orgs/{org}/issue-fields

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/orgs/{org}/issue-fields
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Request body

namestring required

Name of the issue field.

descriptionstring nullable

Description of the issue field.

data_type'text' | 'date' | 'single_select' | 'multi_select' | 'number' required

The data type of the issue field.

visibility'organization_members_only' | 'all'

The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to organization_members_only.

Response

Response

idinteger required

The unique identifier of the issue field.

node_idstring required

The node identifier of the issue field.

namestring required

The name of the issue field.

descriptionstring nullable

The description of the issue field.

data_type'text' | 'date' | 'single_select' | 'multi_select' | 'number' required

The data type of the issue field.

visibility'organization_members_only' | 'all'

The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues).

created_atstring date-time

The time the issue field was created.

updated_atstring date-time

The time the issue field was last updated.

Changes

  • 2022-11-2893714ad5c940Revision changes
    • warning

      added the new multi_select enum value to the response property for the response status

    • info

      added the new multi_select enum value to the request property

  • 2022-11-28eafae1f0dda2Revision changes
    • info

      endpoint added