Versions Compared

Key

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

...

Deck of Cards
idbimAddUserToTeam
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <team_slug>/members 

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

Examplehttps://api-stage.bimplus.net/v2/best-company/members

JSON Structure

Name

Mandatory / Optional

Type

Description

user

mandatory

object

Information of the user

user.id

mandatory

string

Id of the user

user.email

will be ignored

string

Email of the user

user.status

will be ignored

string

Status of the user (Active / Inactive)

role

optional

string

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

member_status

optional

string

Status of the membership (Active / Passive), default is Active

Card
labelHTTP Method
 POST
Card
labelDescription
 Add a specified user to a specified team.
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-ff0593ce15c6"
    },
    "member_status": "Active"
    "role": "Member"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 Ok
Code Block
titleJSON
{
    "user": {
      "id": "3d676814-cf37-aa43-ed03-4b156c282fa1",
      "email": "testuser@allplan.com",
      "status": "Active",
      "firstname": "Test",
      "lastname": "User",
      "company": "Allplan",
      "fullname": "Test User",
      "displayname": "Test User [Allplan]",
      "info": null,
      "gender": "MR",
      "phoneWork": null,
      "phoneHome": null,
      "fax": null,
      "mobile": "123",
      "birthDate": null,
      "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
      },
      "preferedLanguage": "en"
    },
    "role":  "Member",
    "member_status": "Active"
}

...