Skip to main content
PATCH
TypeScript SDK

Suspend or restore someone's access

suspend_or_restore_access

Authorizations

Authorization
string
header
required

A personal access token, which starts with pat_. A Parable token can call each operation that the roles of its owner allow. An MCP token can call only the read operations that are open to agents. A SQL token does not work on this API.

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

userId
string
required

userId parameter UUID v4 string as base62

Body

application/json
status
enum<string>
required

The new status for the workspace user.

Available options:
PENDING,
ACTIVE,
SUSPENDED,
REVOKED

Response

Successful response

data
object
required

A user object from the point of view of a specific Workspace.

meta
object
required