POST /users/{username}/copilot-spaces/{space_number}/collaborators

Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.

Team collaborators are not supported for user-owned Copilot Spaces.

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

Servers

https://api.github.com

Path parameters

Name	Type	Required	Description
`username`	String	Yes	The handle for the GitHub user account.
`space_number`	Integer	Yes	The unique identifier of the Copilot Space.

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

Name	Type	Required	Description
`actor_identifier`	String	Yes	The username of the collaborator. The numeric user ID is also accepted.
`actor_type`	String	Yes	The type of actor (must be `User` for user-owned spaces; `Team` will be rejected). Valid values: `"Team"` `"User"`
`role`	String	Yes	The role to grant to the collaborator. Valid values: `"reader"` `"admin"` `"writer"`

actor_identifier

String

Yes

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

actor_type

String

Yes

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

Valid values:

"Team"
"User"

role

String

Yes

The role to grant to the collaborator.

Valid values:

"reader"
"admin"
"writer"

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.