Add a collaborator to a Copilot Space for a user

2 parameters · 3 body fields

usernamestringrequired

The handle for the GitHub user account.

space_numberintegerrequired

The unique identifier of the Copilot Space.

actor_typestringrequired

The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).

Allowed:UserTeam

actor_identifierstringrequired

The username of the collaborator. The numeric user ID is also accepted.

rolestringrequired

The role to grant to the collaborator.

Allowed:readerwriteradmin

4 status codes

201Response

namestringoptional

emailstringoptional

loginstringrequired

idintegerrequired

node_idstringrequired

avatar_urlstringrequired

gravatar_idstringrequired

urlstringrequired

html_urlstringrequired

followers_urlstringrequired

following_urlstringrequired

gists_urlstringrequired

starred_urlstringrequired

subscriptions_urlstringrequired

organizations_urlstringrequired

repos_urlstringrequired

events_urlstringrequired

received_events_urlstringrequired

typestringrequired

site_adminbooleanrequired

starred_atstringoptional

user_view_typestringoptional

actor_typestringrequired

The collaborator actor type.

Allowed:User

rolestringrequired

The role granted to the collaborator

Allowed:readerwriteradmin

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.collaborators.create({
  username: "octocat",
  spaceNumber: "example",
  actorType: "example",
  actorIdentifier: "example",
  role: "example",
});

{
  "actor_type": "User",
  "role": "writer",
  "login": "octocat",
  "id": 12345,
  "node_id": "MDQ6VXNlcjEyMzQ1",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "gravatar_id": "",
  "url": "https://api.github.com/users/octocat",
  "html_url": "https://github.com/octocat",
  "followers_url": "https://api.github.com/users/octocat/followers",
  "following_url": "https://api.github.com/users/octocat/following{/other_user}",
  "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
  "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
  "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
  "organizations_url": "https://api.github.com/users/octocat/orgs",
  "repos_url": "https://api.github.com/users/octocat/repos",
  "events_url": "https://api.github.com/users/octocat/events{/privacy}",
  "received_events_url": "https://api.github.com/users/octocat/received_events",
  "type": "User",
  "user_view_type": "public",
  "site_admin": false,
  "name": "The Octocat",
  "company": "GitHub",
  "blog": "https://github.com/blog",
  "location": "San Francisco",
  "email": "octocat@github.com",
  "hireable": false,
  "bio": "There once was...",
  "twitter_username": "octocat",
  "public_repos": 2,
  "public_gists": 1,
  "followers": 20,
  "following": 0,
  "created_at": "2008-01-14T04:33:35Z",
  "updated_at": "2008-01-14T04:33:35Z"
}

Was this helpful?

Request

Response

Errors