Organization
Team

Update organization team

Changed on

Update the organization team by its ID.

patch/v1/organizations/{organizationRef}/teams/{team_id}

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations/{organizationRef}/teams/{team_id}
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: organization)

Request body

namestring

Name of the team.

descriptionstring nullable

Description of the team.

Example request

{
  "name": "Platform",
  "description": "Platform engineering team."
}

Response

OK

idstring required

Unique identifier of the team.

namestring required

Name of the team.

descriptionstring nullable

Description of the team.

member_countinteger nullable

Number of users in the team when projected.

created_atstring date-time required

Date when the team was created.

updated_atstring date-time nullable required

Date when the team was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "name": "Platform",
  "description": "Platform engineering team.",
  "member_count": 4
}

Changes

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status