GitHub: Update issue field for an organization

GitHub orgs.orgsUpdateIssueField: arguments, response, policy and SDK examples.

Operation github.orgs_update_issue_field

Provider route: PATCH /orgs/{org}/issue-fields/{issue_field_id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["orgs"]["orgsUpdateIssueField"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.orgs.orgsUpdateIssueField(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.orgs.orgs_update_issue_field(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.org`	string	Required within parent
`path.issue_field_id`	integer	Required within parent
`body`	Model	Required within parent	Expand Update issue field for an organization — request body — body

Referenced models: Update issue field for an organization — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Create issue field for an organization — response body

Referenced models: Create issue field for an organization — response body

Schemas

Create issue field for an organization — response body

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	A custom attribute defined at the organization level for attaching structured data to issues.
`$ (anyOf 1).created_at`	string	Optional	The time the issue field was created. Format: date-time
`$ (anyOf 1).data_type`	string	Required within parent	The data type of the issue field. Known values: text, date, single_select, multi_select, number
`$ (anyOf 1).description`	JSON	Optional
`$ (anyOf 1).description (anyOf 1)`	string	Alternative	The description of the issue field.
`$ (anyOf 1).description (anyOf 2)`	null	Alternative
`$ (anyOf 1).id`	JSON	Required within parent
`$ (anyOf 1).id (anyOf 1)`	integer	Alternative	The unique identifier of the issue field.
`$ (anyOf 1).id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).name`	string	Required within parent	The name of the issue field.
`$ (anyOf 1).node_id`	string	Required within parent	The node identifier of the issue field.
`$ (anyOf 1).options`	JSON	Optional
`$ (anyOf 1).options (anyOf 1)`	array	Alternative	Available options for single select and multi select fields.
`$ (anyOf 1).options (anyOf 1)[]`	object	Each item
`$ (anyOf 1).options (anyOf 1)[].color`	JSON	Optional
`$ (anyOf 1).options (anyOf 1)[].color (anyOf 1)`	string	Alternative	The color of the option. Known values: gray, blue, green, yellow, orange, red, pink, purple
`$ (anyOf 1).options (anyOf 1)[].color (anyOf 2)`	null	Alternative
`$ (anyOf 1).options (anyOf 1)[].created_at`	string	Optional	The time the option was created. Format: date-time
`$ (anyOf 1).options (anyOf 1)[].description`	JSON	Optional
`$ (anyOf 1).options (anyOf 1)[].description (anyOf 1)`	string	Alternative	The description of the option.
`$ (anyOf 1).options (anyOf 1)[].description (anyOf 2)`	null	Alternative
`$ (anyOf 1).options (anyOf 1)[].id`	JSON	Required within parent
`$ (anyOf 1).options (anyOf 1)[].id (anyOf 1)`	integer	Alternative	The unique identifier of the option.
`$ (anyOf 1).options (anyOf 1)[].id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).options (anyOf 1)[].name`	string	Required within parent	The name of the option.
`$ (anyOf 1).options (anyOf 1)[].priority`	JSON	Optional
`$ (anyOf 1).options (anyOf 1)[].priority (anyOf 1)`	JSON	Alternative
`$ (anyOf 1).options (anyOf 1)[].priority (anyOf 1) (anyOf 1)`	integer	Alternative	The priority of the option for ordering.
`$ (anyOf 1).options (anyOf 1)[].priority (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).options (anyOf 1)[].priority (anyOf 2)`	null	Alternative
`$ (anyOf 1).options (anyOf 1)[].updated_at`	string	Optional	The time the option was last updated. Format: date-time
`$ (anyOf 1).options (anyOf 2)`	null	Alternative
`$ (anyOf 1).updated_at`	string	Optional	The time the issue field was last updated. Format: date-time
`$ (anyOf 1).visibility`	string	Optional	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). Known values: organization_members_only, all
`$ (anyOf 2)`	null	Alternative

Update issue field for an organization — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	Description of the issue field.
`description (anyOf 2)`	null	Alternative
`name`	string	Optional	Name of the issue field.
`options`	array	Optional	Options for select fields. Only applicable when updating single_select or multi_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[]`	object	Each item
`options[].color`	string	Required within parent	Color for the option. One of: gray, blue, green, yellow, orange, red, pink, purple
`options[].description`	JSON	Optional
`options[].description (anyOf 1)`	string	Alternative	Description of the option.
`options[].description (anyOf 2)`	null	Alternative
`options[].id`	integer	Optional	The id of an existing option to retain or update. Omit this when creating a new option.
`options[].name`	string	Required within parent	Name of the option.
`options[].priority`	integer	Required within parent	Priority of the option for ordering.
`visibility`	string	Optional	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. One of: organization_members_only, all

Policy, approvals and errors

SDK function policy ID: github.orgs_update_issue_field. Catalog operation: orgs/update-issue-field. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page