## Update a workspace

**patch** `/v1/account/workspaces/{workspaceId}`

Updates a workspace's metadata (e.g. name) and spec. Admin only.

### Path Parameters

- `workspaceId: string`

### Body Parameters

- `metadata: optional object { name, externalId, labels }`

  UpdateAccountResourceMetadata contains the user-provided fields for updating
  an account-scoped resource. Read-only fields (id, account_id, profile_id) are excluded
  since they are set by the server.

  - `name: string`

    Human-readable name for the resource (e.g., "Production API Key", "Staging Workspace")

  - `externalId: optional string`

    External ID for the resource (e.g., a workflow ID from an external system)

  - `labels: optional map[string]`

    Arbitrary key-value pairs for categorization and filtering
    Examples: {"environment": "production", "team": "platform", "version": "v2"}

- `spec: optional WorkspaceSpec`

  - `description: optional string`

- `updateMask: optional string`

  Fields to update.

### Returns

- `Workspace object { metadata, spec, status }`

  - `metadata: AccountResourceMetadata`

    AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

    - `id: string`

      Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

    - `accountId: string`

      Account this resource belongs to for multi-tenant isolation (prefixed ULID)

    - `name: string`

      Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")
      Required for resources that users interact with directly

    - `profileId: string`

    - `externalId: optional string`

      External ID for the resource (e.g., a workflow ID from an external system)

    - `labels: optional map[string]`

      Arbitrary key-value pairs for categorization and filtering
      Examples: {"environment": "production", "team": "platform", "version": "v2"}

  - `spec: WorkspaceSpec`

    - `description: optional string`

  - `status: optional "STATUS_ENABLED" or "STATUS_DISABLED" or "STATUS_ARCHIVED"`

    Lifecycle status of the workspace. Archived workspaces reject all
    requests scoped to them. Server-populated.

    - `"STATUS_ENABLED"`

    - `"STATUS_DISABLED"`

    - `"STATUS_ARCHIVED"`

### Example

```http
curl https://api.cadenya.com/v1/account/workspaces/$WORKSPACE_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CADENYA_API_KEY" \
    -d '{}'
```

#### Response

```json
{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "name": "name",
    "profileId": "profileId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "description": "description"
  },
  "status": "STATUS_ENABLED"
}
```