ConnectCloud Developers

Update a team and its members (desk:admin)

PUT /api/desk/v1/teams/{id}

Module: Desk · operationId: updateTeam · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)

Parameters

Name In Type Required Description
id path string (uuid) yes

Request body

application/json (required)

  • key (string, required): Key of the team, unique in the tenant
  • name (string, required): Name of the team
  • archived (boolean): Archived: the team is kept for existing data but no longer offered in pickers
  • description (string): Description of the team
  • id (string): Id of the team
  • members (array of object): Members of the team
    • role (string): member or lead (one of member, lead)
    • userRef (string): Login (e-mail) of the member

Example:

{
  "archived": false,
  "description": "Netzwerk, Server, Firewall und Projekte vor Ort.",
  "id": "1d8e9f0a-2b3c-4d4e-9f6a-8b9c0d1e2f02",
  "key": "second-level",
  "members": [
    {
      "role": "lead",
      "userRef": "jonas.bauer@muster-it.example"
    },
    {
      "role": "member",
      "userRef": "lukas.wimmer@muster-it.example"
    }
  ],
  "name": "Technik"
}

Responses

  • 200 Saved (application/json)

Fields of the 200 answer:

  • key (string, required): Key of the team, unique in the tenant
  • name (string, required): Name of the team
  • archived (boolean): Archived: the team is kept for existing data but no longer offered in pickers
  • description (string): Description of the team
  • id (string): Id of the team
  • members (array of object): Members of the team
    • role (string): member or lead (one of member, lead)
    • userRef (string): Login (e-mail) of the member

Example 200 answer:

{
  "archived": false,
  "description": "Netzwerk, Server, Firewall und Projekte vor Ort.",
  "id": "1d8e9f0a-2b3c-4d4e-9f6a-8b9c0d1e2f02",
  "key": "second-level",
  "members": [
    {
      "role": "lead",
      "userRef": "jonas.bauer@muster-it.example"
    },
    {
      "role": "member",
      "userRef": "lukas.wimmer@muster-it.example"
    }
  ],
  "name": "Technik"
}

Example request

curl -X PUT 'https://api.mbcom.cloud/api/desk/v1/teams/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"archived":false,"description":"Netzwerk, Server, Firewall und Projekte vor Ort.","id":"1d8e9f0a-2b3c-4d4e-9f6a-8b9c0d1e2f02","key":"second-level","members":[{"role":"lead","userRef":"jonas.bauer@muster-it.example"},{"role":"member","userRef":"lukas.wimmer@muster-it.example"}],"name":"Technik"}'

View as Markdown · Interactive reference · OpenAPI