Workspaces

Change a workspace member's role or access state

Temporarily deactivate or reactivate access, or change the member role. The last active administrator cannot be demoted or deactivated.

patch/workspaces/{id}/members/{user_id}

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/workspaces/{id}/members/{user_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

idstring required

Workspace ID

user_idstring required

Workspace member user ID

Request body

$schemastring uri

A URL to the JSON Schema for this object.

role'admin' | 'editor' | 'client' | 'viewer'

Replacement workspace role

status'active' | 'inactive'

Replacement workspace access state

Example request

{
  "$schema": "https://example.com/api/v1/schemas/UpdateWorkspaceMemberInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring required

When access was first granted

deactivated_atstring

When access was temporarily deactivated

emailstring required

User email

role'admin' | 'editor' | 'client' | 'viewer' required

Workspace role

status'active' | 'inactive' required

Workspace access state

updated_atstring required

When access last changed

user_idstring required

User ID

Example response

{
  "$schema": "https://example.com/api/v1/schemas/WorkspaceMemberResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.