Workspace_users

>>>

PUT /api/v3/workspace_users/:id
Update User Role in Workspace

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "workspace_role_id": 3
}

Success response body ↑

{
  "id": 1,
  "name": "scrumLaunch",
  "available_users_count": 30,
  "can_add_new_users": true,
  "can_invite_users_count": 29,
  "workspace_roles": [
    {
      "id": 1,
      "name": "super_admin",
      "users": []
    },
    {
      "id": 2,
      "name": "creative_admin",
      "users": []
    },
    {
      "id": 3,
      "name": "creator",
      "users": [
        {
          "id": 2,
          "first_name": "Christian",
          "last_name": "Huff",
          "email": "kruchina.vadim@gmail.com",
          "avatar_image": "https://s3.amazonaws.com/gipper-static-assets/stock_images/placeholder_avatar.svg"
        },
        ...
      ]
    },
    {
      "id": 4,
      "name": "editor",
      "users": []
    }
  ]
}

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
workspace_role_id
optional

ID of New Workspace Role

Validations:

  • Must be a Integer
>>>

DELETE /api/v3/workspace_users/:id
Delete User from Workspace

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "id": 4,
  "name": "Vadim Kruchina Workspace",
  "plan": [
    "free"
  ]
}

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
>>>

DELETE /api/v3/workspace_users/bulk_destroy
Remove users from Workspace

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "user_ids": [1, 2, 3...]
}

Success response body ↑

{
  "id": 1,
  "name": "scrumLaunch",
  "workspace_roles": [
    {
      "id": 1,
      "name": "super_admin",
      "can_add_new_users": false,
      "users": []
    },
    {
      "id": 2,
      "name": "creative_admin",
      "can_add_new_users": false,
      "users": []
    },
    {
      "id": 3,
      "name": "creator",
      "can_add_new_users": false,
      "users": [
        {
          "id": 2,
          "first_name": "Christian",
          "last_name": "Huff",
          "email": "kruchina.vadim@gmail.com",
          "avatar_image": "https://s3.amazonaws.com/gipper-static-assets/stock_images/placeholder_avatar.svg"
        },
        ...
      ]
    },
    {
      "id": 4,
      "name": "editor",
      "can_add_new_users": false,
      "users": []
    }
  ]
}

Params

Param name Description
user_ids
required

IDs of users

Validations:

  • Must be an array of Integer