POST
/
manage_workspace_users
Manage workspace users
curl --request POST \
  --url https://api.gumloop.com/api/v1/manage_workspace_users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "organization_id": "<string>",
  "user_id": "<string>",
  "workspace_id": "<string>",
  "action": "add",
  "user_email": "<string>",
  "is_admin": true
}'
{
  "success": true,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
organization_id
string
required

The ID of the organization that the workspace belongs to.

​
user_id
string
required

Your user id -- you must be an organization admin to manage workspace users.

​
workspace_id
string
required

The ID of the workspace to manage users for.

​
action
enum<string>
required

The action to perform - either 'add' or 'remove' a user.

Available options:
add,
remove
​
user_email
string
required

The email address of the target user to add or remove.

​
is_admin
boolean

When adding a user, specify whether they should have admin privileges (default is false).

Response

User successfully added to or removed from workspace

​
success
boolean
​
message
string

A success message describing the action performed.