enterprise-admin

Create or update a custom property for an enterprise

Creates a new or updates an existing custom property that is defined for an enterprise.

To use this endpoint, the authenticated user must be an administrator for the enterprise.

put/enterprises/{enterprise}/properties/schema/{custom_property_name}

Path parameters

enterprisestring required

The slug version of the enterprise name.

custom_property_namestring required

The custom property name

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

{
  "value_type": "single_select",
  "values_editable_by": "org_actors"
}

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