Team_users

>>>

POST /api/v2/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 ↑

{
  "id": 2,
  "name": "team",
  "member_roles_count": 3,
  "admin_roles_count": 1,
  "users": [
    {
      "id": 1,
      "email": "vincent_muller@ferry.co",
      "first_name": "Dianna",
      "last_name": "Morar",
      "avatar_image": null,
      "status_role": "member"
    },
    ...
  ]
}

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
>>>

PUT /api/v2/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 ↑

{
  "id": 2,
  "name": "team",
  "member_roles_count": 3,
  "admin_roles_count": 1,
  "users": [
    {
      "id": 1,
      "email": "vincent_muller@ferry.co",
      "first_name": "Dianna",
      "last_name": "Morar",
      "avatar_image": null,
      "status_role": "member"
    },
    ...
  ]
}

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/v2/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 ↑

{
  "id": 2,
  "name": "team",
  "member_roles_count": 3,
  "admin_roles_count": 1,
  "users": [
    {
      "id": 1,
      "email": "vincent_muller@ferry.co",
      "first_name": "Dianna",
      "last_name": "Morar",
      "avatar_image": null,
      "status_role": "member"
    },
    ...
  ]
}

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