Organization API › Teams
Update a team
PATCH/api/v1/teams/{id}
Renames a team or changes its description. A field left out keeps its value; description: ""
clears the description, and an empty name is refused. The slug does not change.
Permission (API-key scope): identity:team:write.
Authorization
bearerAuth(identity:team:write)apiKeyHeader(identity:team:write)
Parameters
Path parameters
idstring requiredThe id of the member (usr_…), team (team_…), role (role_…), invitation (inv_…) or organization (org_…) the path names.
Request body required
namestringdescriptionstring
Responses
200
The team.
dataTeam requiredShow Team properties
idstring requirednamestring requiredslugstringdescriptionstringorg_idstring requiredmember_countinteger requiredmember_idsarray of string requiredcreated_atstring (date-time) requiredupdated_atstring (date-time) required
successboolean required
400
Not JSON (INVALID_BODY), or a name longer than 100 characters (VALIDATION_ERROR).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
404
No such team in the organization (NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
409
Another team has that name (TEAM_NAME_TAKEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
Example request
curl -X PATCH 'https://evohub.io/api/v1/teams/string' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"description": "Owns the core API and its database"
}'