Update an organization member

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

userIdstringRequired

The unique ID of the User

Body

rolestring · enum · nullableOptional

The role of a member in an organization, null for guests

Possible values:

disabledbooleanOptional

Disable or re-enable the member. Only members disabled by an admin can be re-enabled.

Responses

200

The member has been updated

application/json

objectstring · enumRequired

Type of Object, always equals to "member"

Possible values:

idstringRequired

Unique identifier for the user.

rolestring · enum · nullableRequired

The role of a member in an organization, null for guests

Possible values:

disabledone ofRequired

Why the member is disabled, or false when the member is active. A disabled member cannot access the organization or its content.

boolean · enumOptionalPossible values:

or

string · enumOptional

Why a member is disabled in an organization. "billing": The organization's plan has reached its maximum number of members. "scim": The member was deactivated by the organization's identity provider. "admin": An organization admin disabled the member.

Possible values:

joinedAtstring · date-timeRequired

Date at which the user joined the organization.

lastSeenAtstring · date-timeOptional

Date at which the user was last seen active in the organization.

ssobooleanRequired

Whether the user can login with SSO.

spacesnumberRequired

teamsnumberRequired

sitesnumberRequired

patch/orgs/{organizationId}/members/{userId}

PATCH /v1/orgs/{organizationId}/members/{userId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "role": "admin",
  "disabled": true
}

200

The member has been updated

{
  "object": "member",
  "id": "text",
  "role": "admin",
  "user": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "disabled": false,
  "joinedAt": "2026-01-01T00:00:00.000Z",
  "lastSeenAt": "2026-01-01T00:00:00.000Z",
  "sso": true,
  "spaces": 1,
  "teams": 1,
  "sites": 1
}