Update Team via API
This method allows you to update an existing team.
Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.
URL
/teams/:identifier
HTTP Method
PUT
Supported Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
team[name] |
String | No | The team name |
team[is_admin] |
Boolean | No | Whether the team has account administrator privileges |
team[can_manage_users] |
Boolean | No | Whether members can manage users |
team[can_manage_billing] |
Boolean | No | Whether members can manage billing |
team[can_manage_agents] |
Boolean | No | Whether members can manage network agents |
team[can_create_projects] |
Boolean | No | Whether members can create projects |
team[all_projects_allowed] |
Boolean | No | Whether members can access all projects |
Example cURL Request
curl -X PUT \
-H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
-d '{"team": {"name": "Platform Engineering", "can_manage_agents": true}}' \
https://test.deployhq.com/teams/abc123-def456
Example Response
{
"identifier": "abc123-def456",
"name": "Platform Engineering",
"is_admin": false,
"can_manage_users": false,
"can_manage_billing": false,
"can_manage_agents": true,
"can_create_projects": true,
"all_projects_allowed": true,
"members": [],
"project_assignments": []
}
Notes
- Returns the updated team
- Returns
422 Unprocessable Entityif validation fails - Switching
all_projects_allowedfromfalsetotruewill remove all existing project assignments