このエンドポイントを使用する前に、入門ガイドを完了してAPIキーと会社IDを取得してください。
前提条件
- ✅ 承認済みワークスペースメンバーの有効なBearerトークン
- ✅
GET {{URL}}/accounts/companiesから取得した会社ID - ✅ 更新したい注文の注文ID（プロジェクトID、
pid）
エンドポイント
multipart/form-data — ファイルが添付されていない場合でも、サーバーのマルチパートパーサーを満たすためにこれを使用します。
ヘッダー
クエリパラメータ
string
必須
更新する注文/プロジェクトID。クエリ文字列パラメータとして渡します。
リクエストボディのフィールド
string
注文タイトルを更新します。最小2文字。
string
注文の新しいステータス。
Pending、Ongoing、Review、Completed、Cancelledのいずれかである必要があります。許可される遷移：ReviewはOngoingまたは別のReviewの後にのみ続けることができます。Pendingから直接Reviewに移行しようとすると400 ValidationErrorが返されます。- すでに
CompletedまたはCancelledの注文は更新できません。 - クライアントは
Pendingを過ぎた注文をキャンセルできません。
number
合計予算額。
≥ 0である必要があります。currencyも指定されない限り、注文の既存通貨を使用します。string
予算の通貨コード。例：
USD、CAD、EUR。number
パッケージに対して購入されたユニット数。
≥ 1である必要があります。string
注文の期限のISO 8601日付文字列。例：
"2025-12-31T00:00:00.000Z"。string
プロジェクト開始日のISO 8601日付文字列。
string
チームに表示される内部メモ。
string
クライアントのブリーフまたはプロジェクトの概要。
array
この注文に割り当てるプロジェクトマネージャーメンバーIDの完全なリスト。新しいIDはチームに追加され、削除されたIDは削除されます。各IDは同じ会社内で
projectManagerロールを持つメンバーに属している必要があります。boolean
statusがCompletedまたはCancelledの場合に必須です。trueの場合、ステータス変更後に注文内のすべてのタスクが完了としてマークされます。falseの場合、タスクは現在の状態のままになります。boolean
statusがCompletedまたはCancelledの場合のみ許可されます。trueの場合、ステータス更新後に未処理のクライアントリクエストタスクがすべて却下されます。number
繰り返し頻度を変更する場合のサブスクリプション注文にのみ必要です。
repeatDurationとペアで使用します。string
サブスクリプション注文の
repeatCountと共に必須です。day、week、month、yearのいずれかです。number
定期請求サイクルのオプションの上限。デフォルトは
0（制限なし）。string
各請求サイクルの処理方法。
createOrderWithTask、noChangeのいずれかです。file
ゼロ個以上のファイル添付。ファイルは注文のシステムフォルダに追加され、既存のファイルが上書きされることはありません。
multipart/form-dataエンコーディングを使用し、filesフィールドの下に各ファイルを添付します。リクエスト例
レスポンス
成功レスポンス
ビジネスルールと副作用
- ステータス遷移は制限されています。
ReviewはOngoingまたは別のReviewの後にのみ続けることができます。Pending → Reviewを試みると400 ValidationErrorが返されます。 - ステータスを
PendingからOngoing、Review、またはCompletedに移動すると、注文のファイルフォルダが有効化され、アップロードされたファイルがプロジェクトチームにアクセス可能になります。 statusをCompletedまたはCancelledに設定する場合は、markTasksAsDoneを明示的にtrueまたはfalseに設定することが必須です。Review、Completed、またはCancelledへのステータス変更は自動的にクライアント通知をトリガーします：- Review — レビューが必要であることをクライアントに通知します。
- Completed — クライアントに
orderCompletion通知を送信します。 - Cancelled — クライアントに
orderCancellation通知を送信します。
- 成功した更新ごとに、そのイベントに登録されたアクティブなWebhookがある場合、更新された注文ドキュメントと添付メタデータを含む
ORDER.UPDATEDWebhookイベントが発行されます。