重新命名專案
更新現有專案的名稱及其他屬性。當名稱更改時,專案的 slug 將根據新名稱自動重新生成。
基本範例
mutation RenameProject {
editProject(input: {
projectId: "project_abc123"
name: "Q2 Marketing Campaign"
}) {
id
name
slug
}
}
進階範例
mutation EditProjectAdvanced {
editProject(input: {
projectId: "project_abc123"
name: "Q2 Marketing Campaign"
description: "Campaign for Q2 product launch"
color: "#3B82F6"
icon: "campaign"
category: MARKETING
todoAlias: "Task"
hideRecordCount: false
}) {
id
name
slug
description
color
icon
category
todoAlias
hideRecordCount
}
}
輸入參數
參數 |
類型 |
必填 |
描述 |
projectId |
String! |
✅ 是 |
要編輯的專案 ID |
name |
String |
否 |
專案的新名稱 |
slug |
String |
否 |
自訂的 URL 友好 slug(如果未提供則自動生成) |
description |
String |
否 |
專案描述 |
color |
String |
否 |
專案的十六進位顏色代碼(例如:#3B82F6) |
icon |
String |
否 |
專案的圖示識別碼 |
category |
ProjectCategory |
否 |
專案類別 |
todoAlias |
String |
否 |
此專案中記錄的自訂名稱 |
hideRecordCount |
Boolean |
否 |
是否在 UI 中隱藏記錄計數 |
showTimeSpentInTodoList |
Boolean |
否 |
在列表中顯示時間追蹤 |
showTimeSpentInProject |
Boolean |
否 |
在專案視圖中顯示時間追蹤 |
image |
ImageInput |
否 |
專案圖片/封面 |
todoFields |
[TodoFieldInput] |
否 |
自訂欄位配置 |
coverConfig |
TodoCoverConfigInput |
否 |
封面顯示配置 |
features |
[ProjectFeatureInput] |
否 |
專案的功能開關 |
sequenceCustomFieldId |
String |
否 |
用於記錄排序的自訂欄位 |
ProjectCategory 值
值 |
描述 |
PERSONAL |
個人專案 |
BUSINESS |
商業專案 |
MARKETING |
行銷活動 |
DEVELOPMENT |
開發專案 |
DESIGN |
設計專案 |
OPERATIONS |
營運任務 |
SALES |
銷售活動 |
SUPPORT |
支援票據 |
FINANCE |
財務追蹤 |
HR |
人力資源 |
LEGAL |
法律事務 |
PROCUREMENT |
採購流程 |
回應欄位
返回更新後的專案物件,包含所有欄位。關鍵欄位包括:
欄位 |
類型 |
描述 |
id |
String! |
專案 ID |
name |
String! |
專案名稱 |
slug |
String! |
URL 友好的 slug |
description |
String |
專案描述 |
color |
String |
十六進位顏色代碼 |
icon |
String |
圖示識別碼 |
category |
ProjectCategory |
專案類別 |
todoAlias |
String |
自訂記錄名稱 |
hideRecordCount |
Boolean! |
記錄計數可見性設置 |
createdAt |
DateTime! |
創建時間戳 |
updatedAt |
DateTime! |
最後更新時間戳 |
所需權限
角色 |
可以編輯專案 |
OWNER |
✅ 是 |
ADMIN |
✅ 是 |
MEMBER |
❌ 否 |
錯誤回應
專案未找到
{
"errors": [{
"message": "Project was not found.",
"extensions": {
"code": "PROJECT_NOT_FOUND"
}
}]
}
權限不足
{
"errors": [{
"message": "You don't have permission to edit this project",
"extensions": {
"code": "FORBIDDEN"
}
}]
}
重要說明
- Slug 生成:當名稱更改時,專案 slug 會自動生成。您也可以提供自訂 slug
- Slug 衝突:如果 slug 與現有公司 slug 衝突,系統將附加數字(例如:
my-project-1
)
- HTML 清理:為了安全,描述欄位中的 HTML 標籤會自動去除
- 部分更新:所有欄位都是可選的,除了
projectId
- 只提供您想要更新的欄位
- 類別:對於類別欄位,使用 ProjectCategory 列舉值
- 圖片處理:支持通過 ImageInput 上傳、更新或刪除專案圖片
相關操作