Update team

PATCH 
/v2/orgs/:org_id/teams/:team_id

Updates an existing team.

Required scope

organizations:teams:write

Rate limiting

Level 1

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

Request

Path Parameters

org_id stringrequired
The id of the Organization.
Example: 3074457345618265000
team_id stringrequired
The id of the Team.
Example: 3074457345618265000

application/json

Body

required

name string

Team name

Responses

200

Team object

application/json

Schema

Schema

id stringrequired

Team id

name stringrequired

Team name

picture

object

id int64

Id of the picture

imageURL string

Url of the picture

originalUrl string

Original team picture url for icon generation

type string

Default value: picture

Type of the object returned.

type string

Default value: team

Type of the object returned.

Example (from schema)

{
  "id": "3074457345618265000",
  "name": "My Team",
  "picture": {
    "id": 3074457345618261500,
    "imageURL": "https://miro.images/5252525252/125252/266/144/1/size210.jpg",
    "originalUrl": "https://miro.com/original-image.jpg",
    "type": "picture"
  },
  "type": "team"
}

400

Malformed request

application/json

Schema

Schema

status number

Default value: 400

HTTP status code.

code string

Default value: invalidParameters

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 400,
  "code": "invalidParameters",
  "message": "string",
  "type": "error"
}

401

Invalid authentication credentials

application/json

Schema

Schema

status number

Default value: 401

HTTP status code.

code string

Default value: tokenNotProvided

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 401,
  "code": "tokenNotProvided",
  "message": "string",
  "type": "error"
}

403

Invalid access

application/json

Schema

Schema

status number

Default value: 403

HTTP status code.

code string

Default value: forbiddenAccess

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 403,
  "code": "forbiddenAccess",
  "message": "string",
  "type": "error"
}

404

Invalid access

application/json

Schema

Schema

status number

Default value: 404

HTTP status code.

code string

Default value: notFound

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 404,
  "code": "notFound",
  "message": "string",
  "type": "error"
}

429

Too many requests

application/json

Schema

Schema

status number

Default value: 429

HTTP status code.

code string

Default value: tooManyRequests

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 429,
  "code": "tooManyRequests",
  "message": "string",
  "type": "error"
}

Loading...