Sign in

v56

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

Create or update an organization custom property definition on an enterprise

Creates a new or updates an existing organization custom property definition that is defined on an enterprise.

Access requirements:

  • Enterprise admins
  • OAuth tokens and personal access tokens (classic) with the admin:enterprise scope
  • Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission
put/enterprises/{enterprise}/org-properties/schema/{custom_property_name}

Path parameters

enterprisestring required

The slug version of the enterprise name.

custom_property_namestring required

The custom property name

Request body

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'enterprise_actors' | 'enterprise_and_org_actors' nullable

Who can edit the values of the property.

Example request

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

Response

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'enterprise_actors' | 'enterprise_and_org_actors' nullable

Who can edit the values of the property

Example response

{
  "source_type": "organization",
  "value_type": "single_select",
  "values_editable_by": "enterprise_actors"
}