メインコンテンツへスキップ

​
はじめに

公開の Deals API を使って、Dealレコードの作成、更新、確認、削除を行います。

​
準備するデータ

主に使う項目:
  • Dealの外部ID（例: DEAL-2026-0001）
  • Deal名（例: Enterprise expansion）
  • 会社または連絡先の参照（任意、companyExternalId, contactExternalId）
  • ステータス関連の項目（任意、status, caseStatus）

​
Dealを作成する

curl -X POST "https://api.sanka.com/v1/public/deals" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "DEAL-2026-0001",
    "name": "Enterprise expansion",
    "status": "open",
    "caseStatus": "Qualified",
    "currency": "USD",
    "companyExternalId": "ACME-001",
    "contactExternalId": "CONTACT-100"
  }'
成功すると、レスポンスには case_id、external_id、status、ctx_id が含まれます。

​
Dealを更新する

返ってきた case_id を使って対象レコードを更新します。
curl -X PUT "https://api.sanka.com/v1/public/deals/<case_id>" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Enterprise expansion - renewal",
    "caseStatus": "Proposal",
    "companyExternalId": "ACME-001"
  }'
更新後は次のリクエストで結果を確認できます。
curl -X GET "https://api.sanka.com/v1/public/deals/<case_id>" \
  -H "Authorization: Bearer <access_token>"

​
Dealを削除する

不要になったレコードは削除できます。
curl -X DELETE "https://api.sanka.com/v1/public/deals/<case_id>" \
  -H "Authorization: Bearer <access_token>"
関連してよく使うエンドポイント:
  • Deal一覧: GET /v1/public/deals
  • Deal詳細: GET /v1/public/deals/{case_id}
  • Dealパイプライン一覧: GET /v1/public/deals/pipelines