PATCH /orgs/{org}/properties/schema
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_managerin the organization.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
org |
String | Yes |
The organization name. The name is not case sensitive. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
properties[] |
Array | Yes |
The array of custom properties to create or update. |
properties[].property_name |
String | Yes |
The name of the property |
properties[].default_value |
No |
Default value of the property |
|
properties[].description |
String | No |
Short description of the property |
properties[].url |
String | No |
The URL that can be used to fetch, update, or delete info about this property via the API. |
properties[].required |
Boolean | No |
Whether the property is required. |
properties[].source_type |
String | No |
The source type of the property Valid values:
|
properties[].value_type |
String | Yes |
The type of the value for the property Valid values:
|
properties[].allowed_values[] |
Array | No |
An ordered list of the allowed values of the property. The property can have up to 200 allowed values. |
properties[].values_editable_by |
String | No |
Who can edit the values of the property Valid values:
|
properties[].require_explicit_values |
Boolean | No |
Whether setting properties values is mandatory |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.