Docs
Search docs

Update a team's name, key or default flag

PATCH/api/teams/{team_id}

updateTeam

Partial update; omitted fields are unchanged and an empty body is rejected. Requires workspace admin or owner. The key is uppercased and must match `^[A-Z][A-Z0-9]{1,5}$`; it can change only while the team has never numbered an issue, since every `KEY-N` reference embeds it. `is_default: true` moves the workspace's default-team flag onto this team atomically; `false` is rejected because a workspace always has exactly one default.

Requires authentication using a bearer token or a session cookie — see tokens and scopes.

curl

curl -X PATCH 'https://neosource.dev/api/teams/TEAM_ID' \
  -H 'Authorization: Bearer $NEOSOURCE_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

fetch

fetch("https://neosource.dev/api/teams/TEAM_ID", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer $NEOSOURCE_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

Path parameters

team_idrequired

string

Request bodyrequired

application/json

UpdateTeamRequest

object

Partial update of a team. Every field is optional and omitted fields are untouched; a body that sets nothing is rejected (400).

is_default

boolean | null

`true` makes this team the workspace default, displacing the current one. `false` is rejected (400): the flag is moved, never unset — make another team the default instead (deleting the default team is how a workspace ends up without one).

key

string | null

New team key. Uppercased server-side and validated against `^[A-Z][A-Z0-9]{1,5}$`. Changeable only while the team has never numbered an issue — once `KEY-1` exists the key is locked (409).

name

string | null

Responses

200Team updated

application/json

TeamResponse

object

is_defaultrequired

boolean

issue_sequencerequired

integerint32

keyrequired

string

namerequired

string

team_idrequired

string

workspace_idrequired

string

403Forbidden — one of: forbidden, needs_scope

application/json

one of
  • ErrorForbidden
  • NeedsScopeError

    object

    `403` body returned when a classic OAuth token is asked for something its granted scopes do not cover — an explicit private listing without `repo`, or the one-click GitHub mirror without `admin:public_key`. `scope` names the missing grant so the client can say exactly what the token lacks. There is no elevation route to widen it any more (a re-link goes through the GitHub App, whose tokens carry no scopes), so the client's answer is to say so, never to start a handshake.

    errorrequired

    string

    Always `needs_scope` — this body exists to carry the extra fields that kind needs.

    "needs_scope"

    scoperequired

    string

    The provider scope to request via elevation (e.g. `"repo"`).

Standard errors

Bodies documented once for the whole API — see standard errors.

  • 400Bad Request — one of: invalid_input
  • 401Authentication required
  • 404Not Found — one of: not_found
  • 409Conflict — one of: already_exists, conflict
  • 429Rate limited — retry after the `Retry-After` header
  • 500Internal server error
  • 503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
  • 504Gateway timeout — the request exceeded the server's handling budget