Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimUpdateUserInfoInTeam


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <team_slug>/members/<user_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/members/<user_id>

Examplehttps://api-stage.bimplus.net/v2/best-company>/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

JSON Structure

Name

Mandatory / Optional

Type

Description

user

mandatory

object

Information of the user

user.id

mandatory

string

Id of the user

member_status

mandatory

string

Status of the membership(Active / Passive)

role

optional

string

Team role of the user (Guest /Member / Admin / Owner ), default is Member



Card
labelHTTP Method
 PUT


Card
labelDescription
 Update user's membership in the team by changing his status


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json


Code Block
borderColorRed
langxml
titleJSON
{
    "user": {
        "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7"
    },
    "role": "Admin"
    "member_status": "Active"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



...