更新 Blue 中现有项目的名称
Copy page in markdown for LLMs
重命名项目
更新现有项目的名称和其他属性。当名称更改时,项目的 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
}
}
输入参数
EditProjectInput
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
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 上传、更新或删除项目图像