v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB

orgs

Create or update custom properties for an organization

Creates new or updates existing custom properties defined for an organization in a batch.

If the property already exists, the existing property will be replaced with the new values. Missing optional values will fall back to default values, previous values will be overwritten. E.g. if a property exists with values_editable_by: org_and_repo_actors and it's updated without specifying values_editable_by, it will be updated to default value org_actors.

To use this endpoint, the authenticated user must be one of:

An administrator for the organization.
A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.

patch/orgs/{org}/properties/schema

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Request body

Example request

{
  "properties": [
    {
      "source_type": "organization",
      "value_type": "single_select",
      "values_editable_by": "org_actors"
    }
  ]
}

Response

property_namestring required

The name of the property

urlstring uri

The URL that can be used to fetch, update, or delete info about this property via the API.

source_type'organization' | 'enterprise'

The source type of the property

value_type'string' | 'single_select' | 'multi_select' | 'true_false' | 'url' required

The type of the value for the property

requiredboolean

Whether the property is required.

descriptionstring nullable

Short description of the property

allowed_valuesstring[] nullable

An ordered list of the allowed values of the property. The property can have up to 200 allowed values.

values_editable_by'org_actors' | 'org_and_repo_actors' nullable

Who can edit the values of the property

require_explicit_valuesboolean

Whether setting properties values is mandatory

Example response

[
  {
    "source_type": "organization",
    "value_type": "single_select",
    "values_editable_by": "org_actors"
  }
]