Docs

Update Team

Rename a team. Its members and shares stay as they are.

PUT

Path

Path parameters
stringrequired

The team's id, from List Teams.

Headers

Optional headers
string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments
string

A new name, up to 255 characters, unique in the company (ignoring case).

Response fields

idstring

Unique id of the team.

namestring

The team's name, unique in the company (ignoring case).

memberUserIdsarray of string

The userIds of the people on the team (List Members), earliest added first.

memberCountnumber

How many people are on the team.

createdBystring

The userId of the member who created the team. Null when it is unknown.

createdOndate

When the team was created.

updatedOndate

When the team was last renamed, or created.