Skip to main content
PATCH
Turn a seat on or off, or change a role
Updates need an organization admin and an active Team or Pro subscription billed through cubic. Requests in the playground change the member in your organization. See the Members API guide for expected values and seat capacity rules.

Authorizations

Authorization
string
header
required

Your personal cubic API key from Settings > Integrations > cubic API. It starts with cbk_.

Path Parameters

org
string
required

GitHub organization login, such as acme.

Required string length: 1 - 255
githubUserId
string
required

Numeric GitHub user ID of the member.

Pattern: ^\d{1,20}$

Body

application/json
seat
boolean

Desired seat state. Send with expectedSeat.

role
enum<string>

Desired role. Send with expectedRole.

Available options:
member,
admin,
viewer
expectedSeat
boolean

Current seat state from your latest read; send only with seat.

expectedRole
enum<string>

Current role from your latest read; send only with role.

Available options:
member,
admin,
viewer

Response

OK

githubUserId
string
required
before
object
required
after
object
required
changed
boolean
required
availableSeats
number
required
purchasedQuantityChanged
boolean
required