Team_users

>>>

POST /api/v4/teams/:team_id/team_users
Add new users to team

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 ↑

{
  "team": {
    "id": 20877,
    "name": "team",
    "member_roles_count": 2,
    "admin_roles_count": 1,
    "users": [
      {
        "id": 1,
        "email": "vincent_muller@ferry.co",
        "user_full_name": "Dianna Morar",
        "avatar_image": null,
        "invited": false,
        "team_role_name": "member"
      },
      ...
    ]
  },
  "workspace": {
    "id": 14891,
    "name": "workspace",
    "available_users_count": 30,
    "can_add_new_users": true,
    "can_invite_users_count": 27
  }
}

Params

Param name Description
team_id
required

ID of team

Validations:

  • Must be a Integer
user_emails
required

Emails of invited users

Validations:

  • Must be an array of Integer
sort_by
optional

Validations:

  • Must be one of: email, team_role, name.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
>>>

PUT /api/v4/teams/:team_id/team_users/:id
Update user role

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 ↑

{
  "success": true
}

Params

Param name Description
team_id
required

ID of team

Validations:

  • Must be a Integer
id
required

ID of updated user

Validations:

  • Must be a Integer
role
required

New role of updated user

Validations:

  • Must be one of: member, admin.
>>>

DELETE /api/v4/teams/:team_id/team_users/:id
Remove user from team

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 ↑

{
  "success": true
}

Params

Param name Description
team_id
required

ID of team

Validations:

  • Must be a Integer
id
required

ID of removed user

Validations:

  • Must be a Integer