Rename, describe or move a team

PATCH

/v1/workspace/teams/{team_id}

curl --request PATCH \
  --url https://api.vocapable.com/v1/workspace/teams/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1, "name": "example", "description": "example", "department_id": "example", "clear_department": false, "parent_team_id": "example", "clear_parent": false }'

Authorizations

• HTTPBearer

Parameters

Path Parameters

team_id

required

Team Id

string

Request Body^required

Media typeapplication/json

WorkspaceTeamUpdate

object

expected_revision

required

Expected Revision

integer

>= 1

name

Any of:

string

string

>= 1 characters <= 80 characters

null

null

description

Any of:

string

string

<= 500 characters

null

null

department_id

Any of:

string

string

<= 64 characters

null

null

clear_department

Clear Department

boolean

parent_team_id

Any of:

string

string

<= 64 characters

null

null

clear_parent

Clear Parent

boolean

Responses

200

Successful Response

Media typeapplication/json

WorkspaceTeamDetail

object

team

required

WorkspaceTeamSummary

object

id

required

Id

string

name

required

Name

string

description

required

Any of:

string

string

null

null

department_id

required

Any of:

string

string

null

null

scim_external_id

required

Any of:

string

string

null

null

member_count

required

Member Count

integer

lead_count

required

Lead Count

integer

revision

required

Revision

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

parent_team_id

Any of:

string

string

null

null

depth

Depth

integer

default: 1

department_node_of

Any of:

string

string

null

null

members

required

Members

Array<object>

WorkspaceTeamPerson

object

membership_id

required

Membership Id

string

user_id

required

Any of:

string

string

null

null

name

required

Name

string

email

required

Email

string

is_lead

required

Is Lead

boolean

source

required

Source

string

Allowed values: manual scim import

status

required

Status

string

Allowed values: active suspended

is_primary

Is Primary

boolean

can_manage

required

Can Manage

boolean

Example

{
  "team": {
    "depth": 1
  },
  "members": [
    {
      "source": "manual",
      "status": "active",
      "is_primary": false
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}