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