Edit Workspace

Use the editWorkspace mutation to update an existing workspace. Despite the “rename” framing, this single mutation edits the full workspace surface — name, slug, description, color, icon, category, the record alias, time-tracking display, bulk-action toggles, the name formula, view types, and more. Pass only the fields you want to change; everything else is left untouched.

Workspaces are Workspace objects in the API.

Request

The minimal call renames a workspace. Only projectId is required.

mutation RenameWorkspace {
  editWorkspace(input: { projectId: "project_123", name: "Q2 Marketing Campaign" }) {
    id
    name
    slug
  }
}

Parameters

EditWorkspaceInput

ProjectCategory

ViewTypeSettingInput

Response

{
  "data": {
    "editWorkspace": {
      "id": "clm4n8qwx000008l0g4oxdqn7",
      "name": "Q2 Marketing Campaign",
      "slug": "q2-marketing-campaign"
    }
  }
}

Returns

editWorkspace returns the updated Workspace (non-null).

Full example

Update several settings at once. Categories and view types use enum values (no quotes).

mutation EditWorkspace {
  editWorkspace(
    input: {
      projectId: "project_123"
      name: "Q2 Marketing Campaign"
      description: "Campaign planning for the Q2 product launch."
      color: "#3B82F6"
      icon: "campaign"
      category: MARKETING
      todoAlias: "Task"
      hideRecordCount: false
      duplicateDetection: true
      compactCards: true
      viewTypeSettings: [
        { type: BOARD, enabled: true, name: "Pipeline" }
        { type: DATABASE, enabled: true }
        { type: CALENDAR, enabled: false }
      ]
    }
  ) {
    id
    name
    slug
    description
    color
    icon
    category
    todoAlias
    hideRecordCount
    updatedAt
  }
}

Errors

{
  "errors": [
    {
      "message": "You are not authorized.",
      "extensions": { "code": "FORBIDDEN" }
    }
  ]
}

Permissions

Editing a workspace requires the OWNER or ADMIN access level on that workspace. MEMBER, CLIENT, COMMENT_ONLY, and VIEW_ONLY members cannot call editWorkspace; the mutation throws FORBIDDEN.

Notes

• Renaming does not change the slug. The slug stays as-is unless you pass a new slug explicitly. Provide one if you want the URL to match the new name.
• Slug rules. A slug must be lowercase letters, numbers, and hyphens, contain no URL, and not collide with an existing organization or workspace slug.
• Partial updates. Every field except projectId is optional — send only the fields you want to change.
• Descriptions are sanitized. HTML in description is stripped on save.
• Removing the cover image. Pass image: null to delete the current cover image.

Related

• Create a Workspace
• List Workspaces
• Archive Workspace
• Delete a Workspace
• Manage Lists