GitHub: Create or update a custom property for an organization

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

← Orgs operations · Get started

Operation github.orgs_custom_properties_for_repos_create_or_update_organization_definition

Provider route: PUT /orgs/{org}/properties/schema/{custom_property_name}. 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"]["orgsCustomPropertiesForReposCreateOrUpdateOrganizationDefinition"]>[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.orgsCustomPropertiesForReposCreateOrUpdateOrganizationDefinition(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_custom_properties_for_repos_create_or_update_organization_definition(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.custom_property_name`	string	Required within parent
`body`	Model	Required within parent	Expand Create or update a custom property for an organization — request body — body

Referenced models: Create or update a custom property 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 Get a custom property for an organization — response body

Referenced models: Get a custom property for an organization — response body

Schemas

Get a custom property for an organization — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Custom property defined on an organization
`allowed_values`	JSON	Optional
`allowed_values (anyOf 1)`	array	Alternative	An ordered list of the allowed values of the property. The property can have up to 200 allowed values.
`allowed_values (anyOf 1)[]`	string	Each item
`allowed_values (anyOf 2)`	null	Alternative
`default_value`	JSON	Optional
`default_value (anyOf 1)`	JSON	Alternative	Default value of the property
`default_value (anyOf 1) (anyOf 1)`	string	Alternative
`default_value (anyOf 1) (anyOf 2)`	array	Alternative
`default_value (anyOf 1) (anyOf 2)[]`	string	Each item
`default_value (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	Short description of the property
`description (anyOf 2)`	null	Alternative
`property_name`	string	Required within parent	The name of the property
`require_explicit_values`	boolean	Optional	Whether setting properties values is mandatory
`required`	boolean	Optional	Whether the property is required.
`source_type`	string	Optional	The source type of the property Known values: organization, enterprise
`url`	string	Optional	The URL that can be used to fetch, update, or delete info about this property via the API. Format: uri
`value_type`	string	Required within parent	The type of the value for the property Known values: string, single_select, multi_select, true_false, url
`values_editable_by`	JSON	Optional
`values_editable_by (anyOf 1)`	string	Alternative	Who can edit the values of the property Known values: org_actors, org_and_repo_actors
`values_editable_by (anyOf 2)`	null	Alternative

Create or update a custom property for an organization — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Custom property set payload
`allowed_values`	JSON	Optional
`allowed_values (anyOf 1)`	array	Alternative	An ordered list of the allowed values of the property. The property can have up to 200 allowed values.
`allowed_values (anyOf 1)[]`	string	Each item
`allowed_values (anyOf 2)`	null	Alternative
`default_value`	JSON	Optional
`default_value (anyOf 1)`	JSON	Alternative	Default value of the property
`default_value (anyOf 1) (oneOf 1)`	JSON	Alternative
`default_value (anyOf 1) (oneOf 1) (anyOf 1)`	string	Alternative
`default_value (anyOf 1) (oneOf 1) (anyOf 2)`	null	Alternative
`default_value (anyOf 1) (oneOf 2)`	array	Alternative
`default_value (anyOf 1) (oneOf 2)[]`	string	Each item
`default_value (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	Short description of the property
`description (anyOf 2)`	null	Alternative
`require_explicit_values`	boolean	Optional	Whether setting properties values is mandatory
`required`	boolean	Optional	Whether the property is required.
`value_type`	string	Required within parent	The type of the value for the property One of: string, single_select, multi_select, true_false, url
`values_editable_by`	JSON	Optional
`values_editable_by (anyOf 1)`	string	Alternative	Who can edit the values of the property One of: org_actors, org_and_repo_actors
`values_editable_by (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.orgs_custom_properties_for_repos_create_or_update_organization_definition. Catalog operation: orgs/custom-properties-for-repos-create-or-update-organization-definition. 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