Skip to main content
POST
取引を作成

承認

Authorization
string
header
必須

Stockwork が発行する API キー(sk_ プレフィックス、base62 ランダム ≥ 40 文字)。 キーには 1 つの role(read / analyst / write / admin)が紐付き、 各エンドポイントの必要 role 以上であることが要求される(対応表は info.description 参照)。

ボディ

application/json
properties
object
必須

レスポンス

作成成功

取引(Deal)レコード

id
string
必須

Stockwork record_id(18 文字)。クライアントはこの ID を保存して以降の参照に使う。

:

"Rb7XkQpYz3Lh9vMs2N"

properties
object
必須

取引のプロパティ集合。name は必須。 amount/close_date/stage 等のコアフィールドと、組織別カスタムプロパティが 同じ namespace で扱われる。

リレーションは record_id 文字列で表す。

  • account_id — 商談先の会社(Account)
  • owner_id — 担当ユーザー(User)。GET /v1/users/ で解決する
created_at
string<date-time>
必須
updated_at
string<date-time>
必須

レコードの値が最後に変わった日時。コアフィールド・カスタムプロパティ・アクティビティ件数などの集計値のいずれかが実際に変わったときに進む。商談ログやメールなどの活動を記録した場合も、それが集計値を動かすためこの日時が進む。同じ値での再保存や、他レコードとの紐付け変更では進まない。