Create or update custom property values for a repository

2 parameters · 1 body field

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

propertiesarray<CustomPropertyValue>required

A list of custom property names and associated values to apply to the repositories.

4 status codes

204No Content when 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 "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.values.update({
  owner: "octocat",
  repo: "hello-world",
  properties: [],
});

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

Request

Response

Errors