Skip to main content
PATCH
/
teams
/
{team_id}
Update a team
curl --request PATCH \
  --url https://api.shiftkeeper.io/teams/{team_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Payments",
  "description": "All about payments and billing"
}
'
{
  "team": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Enter your API key which starts with 'keeper_'

Path Parameters

​
team_id
string
required

The ID of the team.

Example:

"tea_VJ4sYEOOXVvJBXqFjRzpm"

Body

application/json
​
name
string

The name of the team.

Required string length: 1 - 60
​
description
string

The description of the team.

Maximum string length: 200

Response

Default Response

​
team
object
required
Example:
{
  "id": "tea_VJ4sYEOOXVvJBXqFjRzpm",
  "name": "Payments",
  "description": "All about payments and billing"
}