PATCH /orgs/{org}/issue-fields/{issue_field_id}

Updates an 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.

Servers

https://api.github.com

Path parameters

Name	Type	Required	Description
`org`	String	Yes	The organization name. The name is not case sensitive.
`issue_field_id`	Integer	Yes	The unique identifier of the issue field.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`visibility`	String	No	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. Valid values: `"organization_members_only"` `"all"`
`name`	String	No	Name of the issue field.
`description`	String	No	Description of the issue field.
`options[]`	Array	No	Options for single select fields. Only applicable when updating single_select fields. When provided, this array replaces the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its `id`. Options sent without an `id` are treated as new options and may cause existing options to be deleted and recreated.
`options[].id`	Integer	No	The id of an existing option to retain or update. Omit this when creating a new option.
`options[].priority`	Integer	Yes	Priority of the option for ordering.
`options[].name`	String	Yes	Name of the option.
`options[].description`	String	No	Description of the option.
`options[].color`	String	Yes	Color for the option. Valid values: `"yellow"` `"red"` `"purple"` `"gray"` `"blue"` `"pink"` `"orange"` `"green"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.