リファレンスHTTP APITeams

Rename a team

PATCH
/v1/teams/{team_id}

Writes a rename_team receipt unless the name is unchanged (receipt_id null).

Auth: cookie session only; no scope. Idempotency-Key: ignored.

Authorization

cookieSession
cookie__Host-werft_session<token>

For the web console: the browser session cookie set by POST /v1/auth/login. It holds the scopes of the user's workspace role (owner: all; admin and member: all but sessions:recover). Requests other than GET must also send X-Requested-With: werft-web.

Path Parameters

team_id*string

The team's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Header Parameters

X-Requested-With?"werft-web"

Required with a cookie session: the literal werft-web.

Value in"werft-web"

Request Body

application/json
  1. body
name*string
Length1 <= length <= 100

Response Body

The team after the rename.

application/json
  1. response
team*
receipt_id*|null
Example Request
curl -X PATCH 'https://example.com/v1/teams/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "name": "research leads"}'
Example Response
{  "team": {    "id": "019a0000-0000-7000-8000-00000000b0a1",    "workspace_id": "9d2c4e61-8a3b-4f70-b1e5-6c0a7d3f2b98",    "name": "research leads",    "member_count": 2,    "created_by": "3e7f1a90-5c2d-4b8e-8f61-2a9d0c4b7e35",    "created_at": "2026-10-23T09:00:00Z",    "revision": 4  },  "receipt_id": "c4a1e9d2-7b3f-4e8a-a6c5-1d2e3f4a5b6c"}