取引レコードには、進行中の商取引に関するデータが格納されます。取引エンドポイントを使用することにより、取引データを管理したり、HubSpotと他のシステムとの間で同期したりできます。
POST
リクエストを/crm/v3/objects/deals
に送信します。
リクエスト本文のproperties
オブジェクトに取引データを含めます。また、associations
オブジェクトを追加して、新しい取引を既存のレコード(コンタクト、会社など)またはアクティビティー(ミーティング、メモなど)に関連付けることもできます。
dealname
とdealstage
のプロパティーをリクエストに含める必要があります。また、複数のパイプラインがある場合はpipeline
も含めます。パイプラインが指定されない場合、デフォルトのパイプラインが使用されます。
利用可能な全てのプロパティーを確認するには、GET
リクエストを/crm/v3/properties/deals
に送信して、アカウントの取引プロパティーのリストを取得します。詳しくはプロパティーAPIをご参照ください。
associations
オブジェクトで既存のレコードまたはアクティビティーに関連付けることもできます。例えば、新しい取引を既存のコンタクトと会社に関連付ける場合、リクエストの内容は以下のようになります。
associations
オブジェクトに含める必要があります。
パラメーター | 説明 |
---|---|
to | 取引に関連付けるレコードまたはアクティビティー。一意のid 値で指定します。 |
types | 取引とレコードまたはアクティビティーの間の関連付けのタイプ。associationCategory とassociationTypeId を含めます。デフォルトの関連付けタイプIDはこちらのページに記載されています。または、関連付けAPIを使用して、カスタム関連付けタイプ(ラベル)の値を取得することもできます。 |
GET
リクエストを/crm/v3/objects/deals/{dealId}
に送信します。GET
リクエストを/crm/v3/objects/deals
に送信します。パラメーター | 説明 |
---|---|
properties | レスポンスで返されるプロパティーのカンマ区切りリスト。リクエスト対象の取引レコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。 |
propertiesWithHistory | レスポンスで返される現在および過去のプロパティーのカンマ区切りリスト。リクエスト対象の取引レコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。 |
associations | 関連付けられたIDを取得する対象のオブジェクトのカンマ区切りリスト。存在しない関連付けを指定した場合、その関連付けはレスポンスで返されません。詳しくは関連付けAPIをご参照ください。 |
POST
リクエストをcrm/v3/objects/deals/batch/read
に送信します。
idProperty
パラメーターを含めてプロパティー名を指定します。次に、inputs
配列に取引IDではなく固有IDプロパティーの値を含めます。propertiesWithHistory
パラメーターを含めます。
PATCH
リクエストに更新対象のデータを含めて/crm/v3/objects/deals/{dealId}
に送信します。POST
リクエストを/crm/v3/objects/deals/batch/update
に送信します。リクエストの本文に、取引の識別子と更新するプロパティーを含む配列を含めます。PUT
リクエストを/crm/v3/objects/deals/{dealId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
に送信します。
associationTypeId
値を取得するには、デフォルト値のリストを参照するか、GET
リクエストを/crm/v4/associations/{fromObjectType}/{toObjectType}/labels
に送信します。DELETE
リクエストを/crm/v3/objects/deals/{dealId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
に送信します。
hs_pinned_engagement_id
パラメーターを含めることで、APIを介して取引レコードでアクティビティーをピン留めできます。パラメーターの値には、ピン留めするアクティビティーのIDを指定します。これはエンゲージメントAPIを介して取得できます。レコードごとに1つのアクティビティーをピン留めすることができ、そのアクティビティーはピン留めする前にすでに取引に関連付けられている必要があります。
取引にピン留めするアクティビティーを設定または更新する場合、リクエストは以下のようになります。
DELETE
リクエストを/crm/v3/objects/deals/{dealId}
に送信します。このリクエストにリクエスト本文は必要ありません。POST
リクエストを/crm/v3/objects/deals/batch/archive
に送信します。以下の例のように、リクエスト本文には取引IDの値をid
入力として含めます。