Update brand kit

Update a Brand kit name or description.

Outcome

Update a Brand kit name or description.

Before you start

Verify whoami and the pinned credential context, then inspect the exact discovered action before preparing input.
Discover a granted Brand workspace. Pass its resourceType/workspace identifier separately from input; a copied fixture identifier grants no access.
The declared permission is brand:write. The active credential, application scope, resource binding and runtime authority must all authorize the request.
Review the exact mutation and recovery, including destructive scope, and execute only after the intended effect is authorized.

Discover the target

topolo whoami --json
topolo actions get app_topolo_brand.brand_kits.update --detail --json
topolo resources topolo-brand --json
topolo workspaces list topolo-brand --json

Request

PATCH /api/brand-kits/{id}

Resource context is the selected Brand workspace. CLI/SDK action input includes path identifiers; direct HTTP JSON bodies exclude path parameters. Read the reviewed plan for the exact request.

Input fields

Field	Required	Meaning
`id`	Yes	Exact kit or binding identifier from the corresponding list action; its meaning is determined by this action.
`name`	Conditional/optional	Human-readable kit or asset name. Kit metadata changes do not modify an immutable published snapshot.
`description`	Conditional/optional	Kit description, at most 500 characters. An omitted creation description becomes an empty string.

Exact published input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact kit or binding identifier from the corresponding list action; its meaning is determined by this action."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "Human-readable kit or asset name. Kit metadata changes do not modify an immutable published snapshot."
    },
    "description": {
      "type": "string",
      "maxLength": 500,
      "description": "Kit description, at most 500 characters. An omitted creation description becomes an empty string."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "name"
      ]
    },
    {
      "required": [
        "description"
      ]
    }
  ]
}

Effects

Changes only supplied kit metadata fields and writes an audit row. Published version snapshots remain immutable.

Interpret the response

brandKit is the updated container. Supply at least name or description; slug is not editable through this action. Updated container metadata does not change presentation.name from a published snapshot.

Response identifier contract:

{
  "kind": "brand_kit",
  "identifierSource": "response",
  "idPath": "$.brandKit.id"
}

Worked examples

These complete synthetic responses were captured from the local worker over canonical SQL migrations. Auth and R2 dependencies are simulated; notification delivery is not exercised. Set BRAND_WORKSPACE_ID from granted workspace discovery. Save reviewed input as payload.json, validate and inspect the unchanged plan. The final mutation command and MCP confirm flag assume the intended effect has already been authorized.

Minimal example

Input · payload.json:

{
  "id": "brand_c794be50-0306-4933-8de8-5609340bed9e",
  "name": "Reviewed fixture identity"
}

CLI:

topolo actions validate app_topolo_brand.brand_kits.update --data @payload.json --json
topolo actions plan app_topolo_brand.brand_kits.update --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_brand.brand_kits.update --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_brand.brand_kits.update",
    "input": {
      "id": "brand_c794be50-0306-4933-8de8-5609340bed9e",
      "name": "Reviewed fixture identity"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "brandKit": {
    "id": "brand_c794be50-0306-4933-8de8-5609340bed9e",
    "organizationId": "org_documentation_fixture",
    "name": "Reviewed fixture identity",
    "slug": "fixture-minimal",
    "description": "",
    "status": "active",
    "createdAt": "2026-10-03T11:23:59.056Z",
    "updatedAt": "2026-10-03T11:23:59.062Z",
    "currentVersionId": null
  }
}

Workflow example

Input · payload.json:

{
  "id": "brand_55886012-13a4-4e95-ad31-3fe2b52cdf20",
  "name": "Reviewed fixture identity"
}

CLI:

topolo actions validate app_topolo_brand.brand_kits.update --data @payload.json --json
topolo actions plan app_topolo_brand.brand_kits.update --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_brand.brand_kits.update --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_brand.brand_kits.update",
    "input": {
      "id": "brand_55886012-13a4-4e95-ad31-3fe2b52cdf20",
      "name": "Reviewed fixture identity"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "brandKit": {
    "id": "brand_55886012-13a4-4e95-ad31-3fe2b52cdf20",
    "organizationId": "org_documentation_fixture",
    "name": "Reviewed fixture identity",
    "slug": "fixture-workflow",
    "description": "A governed example identity",
    "status": "active",
    "createdAt": "2026-10-03T11:23:59.104Z",
    "updatedAt": "2026-10-03T11:23:59.105Z",
    "currentVersionId": null
  }
}

Verify the result

Read brand_kits.get and compare the changed metadata with the intended values.

Errors and recovery

refused · HTTP 404

{
  "input": {
    "id": "missing-fixture",
    "name": "Missing fixture"
  },
  "response": {
    "error": "brand_kit_not_found"
  }
}

auth_error (HTTP 401): CLI/SDK authentication classification when Auth returns a non-code message: restore the authorized credential, then verify whoami and context. Preserve the exact service message.
permission_denied (HTTP 403): Use the exact permission and granted resource required by the reviewed action; organization membership alone is insufficient.
workspace_required (HTTP 400): Discover and select a granted Brand workspace before preparing the request.
brand_storage_unavailable (HTTP 503): The Brand storage bindings are unavailable. Preserve the request identifier and report the service fault; do not retry an unverified mutation.
brand_kit_not_found (HTTP 404): Discover the exact parent/resource again and inspect its lifecycle status. Missing, inaccessible or immutable resources can share this refusal.

Recovery boundary

Capture prior name and description, then review an authorized update restoring those values.

app_topolo_brand.brand_kits.get: Read one Brand kit and the presentation of its current published version.

Evidence

Four real local SQLite stores use all canonical migrations; Auth identity/grants and archival plus R2 object storage are explicitly simulated. Notifications are disabled in fixtures. No notification delivery, live mutation, gateway credential parity or deployed environment proof is claimed. Fixture identifiers and timestamps are synthetic and must be replaced by exact authorized resource discovery.