PUT/orgs/{org}/copilot-spaces/{space_number}

Set an organization Copilot Space

Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.

Organization members with appropriate permissions can update Copilot Spaces owned by their organization.

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 5 body fields

orgstringrequired

The organization name. The name is not case sensitive.

space_numberintegerrequired

The unique identifier of the Copilot Space.

namestringoptional

The name of the Copilot Space.

descriptionstringoptional

A description of the Copilot Space.

general_instructionsstringoptional

General instructions for the Copilot Space.

base_rolestringoptional

The base role that determines default permissions for organization members. Changing this field requires admin permissions. - `no_access`: No default access (default) - `reader`: Organization members can read the space - `writer`: Organization members can read and edit the space - `admin`: Organization members have full admin access to the space

Allowed:readerwriteradminno_access

resources_attributesarray<object>optional

Resources to attach to the space.

4 status codes

200Response

idintegerrequired

The unique identifier of the space.

numberintegerrequired

The number that identifies the space within its owner.

namestringrequired

The display name of the space.

descriptionstringoptional

A description of the space.

general_instructionsstringoptional

General instructions for the Copilot Space.

base_rolestringrequired

The base role that determines default permissions. - `no_access`: No default access - `reader`: Default read permissions - `writer`: Default write permissions (organization spaces only) - `admin`: Default admin permissions (organization spaces only)

Allowed:readerwriteradminno_access

ownerobjectrequired

The user or organization that owns this space.

creatorobjectrequired

A GitHub user.

created_atstringrequired

The date and time the space was created.

updated_atstringrequired

The date and time the space was last updated.

html_urlstringrequired

The HTML URL of the space.

api_urlstringrequired

The API URL of the space.

resources_attributesarray<object>optional

Resources attached to the space.

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 "octri-github";

const client = new Client({
  baseUrl: "https://api.github.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.copilotSpaces.update({
  org: "acme-inc",
  spaceNumber: "example",
  name: "Untitled",
  description: "Lorem ipsum",
  generalInstructions: "example",
});

{
  "id": 84,
  "number": 3,
  "name": "Team Planning Space",
  "description": "Organization space for team planning and coordination",
  "general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices",
  "owner": {
    "login": "octo-org",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "url": "https://api.github.com/orgs/octo-org",
    "repos_url": "https://api.github.com/orgs/octo-org/repos",
    "events_url": "https://api.github.com/orgs/octo-org/events",
    "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
    "issues_url": "https://api.github.com/orgs/octo-org/issues",
    "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
    "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "description": "A great organization",
    "gravatar_id": "",
    "name": "octo-org",
    "company": "GitHub",
    "blog": "https://github.com/blog",
    "location": "San Francisco",
    "email": "octocat@github.com",
    "twitter_username": "octo-org",
    "html_url": "https://github.com/octo-org",
    "created_at": "2008-01-14T04:33:35Z",
    "updated_at": "2017-08-17T12:37:15Z",
    "type": "Organization"
  },
  "creator": {
    "login": "defunkt",
    "id": 2,
    "node_id": "MDQ6VXNlcjI=",
    "avatar_url": "https://github.com/images/error/defunkt_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/defunkt",
    "html_url": "https://github.com/defunkt",
    "followers_url": "https://api.github.com/users/defunkt/followers",
    "following_url": "https://api.github.com/users/defunkt/following{/other_user}",
    "gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/defunkt/subscriptions",
    "organizations_url": "https://api.github.com/users/defunkt/orgs",
    "repos_url": "https://api.github.com/users/defunkt/repos",
    "events_url": "https://api.github.com/users/defunkt/events{/privacy}",
    "received_events_url": "https://api.github.com/users/defunkt/received_events",
    "type": "User",
    "site_admin": true
  },
  "created_at": "2023-02-15T08:30:00Z",
  "updated_at": "2023-02-15T14:45:00Z",
  "html_url": "https://github.com/copilot/spaces/octo-org/3",
  "api_url": "https://api.github.com/organizations/1/copilot-spaces/3",
  "base_role": "no_access",
  "resources_attributes": [
    {
      "id": 123,
      "resource_type": "github_file",
      "metadata": {
        "repository_id": 456,
        "file_path": "docs/planning.md"
      }
    },
    {
      "id": 124,
      "resource_type": "free_text",
      "metadata": {
        "name": "Team Guidelines",
        "text": "Our team follows agile methodology"
      }
    }
  ]
}

Was this helpful?

Request

Response

Errors