リファレンスHTTP APIWorkspace settings

Archive an achievement category

POST
/v1/achievement-categories/{id}/archive

Owners and admins (achievement_rule.manage), signed in; API keys are refused. A category with a rule in use (its latest version, not disabled) is 409 REVISION_CONFLICT with details.reason_code: category_in_use. Archiving one already archived changes nothing and answers a null receipt_id; otherwise writes an archive_achievement_category receipt. Another workspace's category 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 category'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"

Response Body

The category as archived.

application/json
  1. response
category*
receipt_id*|null
Example Request
curl -X POST 'https://example.com/v1/achievement-categories/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive'
Example Response
{  "category": {    "id": "5b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e",    "name": "Delivery",    "position": 0,    "created_by": "3e7f1a90-5c2d-4b8e-8f61-2a9d0c4b7e35",    "created_at": "2026-11-02T01:00:00.000Z",    "archived_at": "2026-11-02T02:00:00.000Z",    "archived_by": "3e7f1a90-5c2d-4b8e-8f61-2a9d0c4b7e35"  },  "receipt_id": "c4a1e9d2-7b3f-4e8a-a6c5-1d2e3f4a5b6c"}