Teams

Update a team

Updates an existing team's information. All fields are optional - only provide the fields you want to update.

You can update basic information like name, emoji, and cost center code. Providing userIds replaces the team's full membership: users in the list are added, and users not in the list move to the default team, Unassigned.

The default team (isDefault: true in GET /v1/teams) cannot be updated.

patch/v1/teams/{teamId}

Request

Base URL
https://api.telgea.com
Auth
API key in header x-api-key

Path parameters

teamIdstring uuid required

UUID of the team.

Example:2f6b0d3a-8c1e-4a7f-9b2d-1e3c4d5f6a70

Headers

idempotency-keystring

A value unique to this request, of 1 to 255 printable ASCII characters — a UUID is the usual choice. Retry with the same key within 24 hours and you get the original response back, even if it was a failure, and nothing is done twice. Send a new key whenever you change the request. Keys are private to your API key and organisation.

Example:0b7e4f1c-6a2d-4c9e-8f35-d1a7b2c93e60

Request body

namestring

Team name

emojistring

Emoji representing the team

costCodestring

Cost center code applied to all users in this team

userIdsstring[]

Full desired member list. When provided, replaces the team's membership: users not in the list are removed, new user IDs are added.

Example request

{
  "name": "Field Sales",
  "emoji": "🚀",
  "costCode": "IT 5000",
  "userIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Response

Team updated successfully. No content returned.

Changes

No recorded changes to this operation across all 1 revision of this API.