Skip to main content
更新订单端点允许您从外部系统或自动化脚本修改 AgencyHandy 中的现有订单(项目) — 更改其名称、状态、预算、时间表、分配的经理等。该端点还支持文件附件,附件将被追加到订单的系统文件夹中。
使用此端点之前,请完成入门指南以获取您的 API 密钥和公司 ID。
此端点使用 Authorization: Bearer <token>(已登录成员的访问令牌),而非仅使用 x-api-key 标头。请确保您的调用方已作为目标公司的已批准成员完成身份验证。未授权的调用方将收到 403 PermissionError

前提条件

  • ✅ 已批准工作区成员的有效 Bearer 令牌
  • ✅ 从 GET {{URL}}/accounts/companies 获取的公司 ID
  • ✅ 您要更新的订单的订单 ID(项目 ID,pid

端点

Content-Type: multipart/form-data — 即使没有附件文件,也请使用此格式以满足服务器的 multipart 解析器要求。

标头

查询参数

string
必填
要更新的订单 / 项目 ID。作为查询字符串参数传递。

请求主体字段

string
更新订单标题。最少 2 个字符。
string
订单的新状态。必须为以下之一:PendingOngoingReviewCompletedCancelled允许的状态转换:
  • Review 只能在 Ongoing 或另一个 Review 之后设置。从 Pending 直接跳转到 Review 将返回 400 ValidationError
  • 已处于 CompletedCancelled 状态的订单无法更新。
  • 客户无法取消已超过 Pending 状态的订单。
number
总预算金额。必须 ≥ 0。若未同时提供 currency,则使用订单的现有货币。
string
预算的货币代码。示例:USDCADEUR
number
套餐购买的单位数量。必须 ≥ 1
string
订单截止日期的 ISO 8601 日期字符串。示例:"2025-12-31T00:00:00.000Z"
string
项目开始日期的 ISO 8601 日期字符串。
string
您的团队可见的内部备注。
string
客户简报或项目摘要。
array
分配到此订单的项目经理成员 ID 完整列表。新 ID 将被添加到团队;已移除的 ID 将被删除。每个 ID 必须属于同一公司内具有 projectManager 角色的成员。
boolean
statusCompletedCancelled必填。为 true 时,状态变更后订单中的所有任务将被标记为已完成。为 false 时,任务保持当前状态。
boolean
仅在 statusCompletedCancelled 时允许使用。为 true 时,状态更新后所有待处理的客户请求任务将被拒绝。
number
仅在变更订阅订单的重复频率时需要。与 repeatDuration 配合使用。
string
订阅订单中与 repeatCount 配合使用的必填字段。以下之一:dayweekmonthyear
number
定期计费周期的可选限制。默认为 0(无限制)。
string
每个计费周期的处理方式。以下之一:createOrderWithTasknoChange
file
零个或多个文件附件。文件将被追加到订单的系统文件夹;现有文件不会被覆盖。使用 multipart/form-data 编码,并将每个文件附在 files 字段下。

示例请求

等效 JSON 负载(发送文件时请转换为 multipart 表单条目):

响应

成功响应


业务规则和副作用

  • 状态转换受到限制。Review 只能在 Ongoing 或另一个 Review 之后设置。尝试 Pending → Review 将返回 400 ValidationError
  • 将状态从 Pending 变更为 OngoingReviewCompleted 会激活订单的文件文件夹,使上传的文件对项目团队可访问。
  • status 设置为 CompletedCancelled 需要markTasksAsDone 明确设置为 truefalse
  • 状态变更为 ReviewCompletedCancelled 会自动触发客户通知:
    • Review — 通知客户需要进行审查。
    • Completed — 向客户发送 orderCompletion 通知。
    • Cancelled — 向客户发送 orderCancellation 通知。
  • 每次成功更新都会触发一个 ORDER.UPDATED Webhook 事件,附带更新后的订单文档和附件元数据(前提是您有订阅该事件的有效 Webhook)。