레퍼런스HTTP APIWorkspace settings

Rename an achievement type

PATCH
/v1/achievement-types/{id}

Owners and admins (achievement_rule.manage), signed in; API keys are refused. Only name changes; a body naming key or evidence_kind is 400. To count under another key or evidence kind, make a new type and move the rule to it in a new version. Writes an update_achievement_type receipt unless the name is unchanged (receipt_id null). Another workspace's type is 404.

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

id*string

The achievement type'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 <= 40

Response Body

The type as renamed.

application/json
  1. response
type*
receipt_id*|null
Example Request
curl -X PATCH 'https://example.com/v1/achievement-types/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "name": "Design document"}'
Example Response
{  "type": {    "id": "6c2f3d4e-5a6b-4c7d-9e8f-0a1b2c3d4e5f",    "key": "design_doc",    "name": "Design document",    "evidence_kind": "out_file",    "builtin": false,    "created_by": "3e7f1a90-5c2d-4b8e-8f61-2a9d0c4b7e35",    "created_at": "2026-11-02T01:00:00.000Z",    "archived_at": null,    "archived_by": null  },  "receipt_id": "c4a1e9d2-7b3f-4e8a-a6c5-1d2e3f4a5b6c"}