PATCH/orgs/{org}/properties/installations/values

Create or update external custom property values for organization repositories

Create new or update existing external custom property values for repositories in a batch that belong to an organization. Each target repository will have its external custom property values updated to match the values provided in the request.

A maximum of 30 repositories can be updated in a single request.

Using a value of null for an external custom property will remove or 'unset' the property value from the repository.

To use this endpoint, the authenticated GitHub App must have the organization_external_properties_for_repos:write permission.

IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields

orgstringrequired

The organization name. The name is not case sensitive.

repository_namesarray<string>required

The names of repositories that the external custom property values will be applied to.

propertiesarray<CustomPropertyValue>required

List of external custom property names and associated values to apply to the repositories.

4 status codes

204No Content when external custom property values are successfully created or updated

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

422Validation failed, or the endpoint has been spammed.

messagestringrequired

documentation_urlstringrequired

errorsarray<object>optional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.values.update({
  org: "acme-inc",
  repositoryNames: "hello-world",
  properties: [],
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors