ミーティングエンゲージメントAPIを使用して、CRMレコードのミーティングを記録および管理できます。
POST
リクエストを/crm/v3/objects/meetings
に送信します。
リクエスト本文で、propertiesオブジェクト内にミーティングの詳細を追加します。また、associationsオブジェクトを追加して、新しいミーティングを既存のレコード(コンタクト、会社など)に関連付けることもできます。
フィールド | 説明 |
---|---|
hs_timestamp | 必須。このフィールドは、ミーティングが実施された日時を示します。ミリ秒単位またはUTC形式のUnixタイムスタンプを使用できます。プロパティー値がない場合、デフォルトの値hs_meeting_start_time. に設定されます。 |
hs_meeting_title | ミーティングのタイトル。 |
hubspot_owner_id | ミーティングに関連付けられている所有者のID。このフィールドにより、レコードタイムラインにミーティング作成者として表示されるユーザーが決まります。 |
hs_meeting_body | ミーティングの説明。 |
hs_internal_meeting_notes | 出席者のミーティング説明に含まれていない、ミーティング中にチームのために取る内部メモ。 |
hs_meeting_external_url | カレンダーイベントの外部URL。Google カレンダーやMicrosoft Outlookカレンダーのリンクなどが含まれます。 |
hs_meeting_location | ミーティングの実施場所。値には、実際の住所、会議室、ビデオ会議のリンク、または電話番号のいずれかを指定できます。これは、出席者のカレンダーのカレンダー招待に表示されます。 |
hs_meeting_start_time | ミーティングが開始される日時。このプロパティーの値は、hs_timestamp の値と一致している必要があります。 |
hs_meeting_end_time | ミーティングが終了する日時。 |
hs_meeting_outcome | ミーティングの結果。結果の値は、スケジュール済み、完了、再スケジュール済み、欠席、またはキャンセル済みのいずれかです。 |
hs_activity_type | ミーティングのタイプ。利用可能なオプションは、HubSpotアカウントで設定されたミーティングのタイプに基づきます。 |
hs_attachment_ids | ミーティングの添付ファイルのID。複数の添付ファイルIDはそれぞれセミコロンで区切られます。 |
フィールド | 説明 |
---|---|
to | ミーティングに関連付けるレコード。一意のid 値で指定します。 |
types | ミーティングとレコードの間の関連付けのタイプ。associationCategory とassociationTypeId を含めます。デフォルトの関連付けタイプIDはこちらのページに記載されています。または、関連付けAPIを使用して、カスタム関連付けタイプ(ラベル)の値を取得することもできます。 |
GET
リクエストを/crm/v3/objects/meetings/{meetingId}
に送信します。また、リクエストのURLには次のパラメーターを含めることができます。
パラメーター | 説明 |
---|---|
properties | 返されるプロパティーのカンマ区切りリスト。 |
associations | 関連付けられたレコードIDの取得元となるオブジェクトのカンマ区切りリスト。 |
GET
リクエストをcrm/v3/objects/meetings
に送信します。リクエストのURLには、次のパラメーターを含めることができます。
パラメーター | 説明 |
---|---|
limit | ページごとに表示する結果の最大数。 |
properties | 返されるプロパティーのカンマ区切りリスト。 |
PATCH
リクエストを/crm/v3/objects/meetings/{meetingId}
に送信します。
リクエスト本文に、更新するミーティングプロパティーを含めます。例えば、リクエスト本文は次のようになります。
PUT
リクエストを/crm/v3/objects/meetings/{meetingId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
に送信します。リクエストのURLは次のフィールドからなります。
フィールド | 説明 |
---|---|
meetingId | ミーティングのID。 |
toObjectType | ミーティングに関連付けるオブジェクトのタイプ(コンタクト、会社など)。 |
toObjectId | ミーティングに関連付けるレコードのID。 |
associationTypeId | ミーティングと他のオブジェクトタイプとの間の関連付けタイプのID。この値は関連付けAPIを介して取得できます。 |
https://api.hubspot.com/crm/v3/objects/meetings/17612479134/associations/contact/104901/200
DELETE
リクエストを送信します。
/crm/v3/objects/meetings/{meetingId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
hs_pinned_engagement_id
フィールドにミーティングのid
を含めます。会社、コンタクト、取引、チケット、およびカスタムオブジェクトAPIの使用の詳細については、こちらをご覧ください。
DELETE
リクエストを/crm/v3/objects/meetings/{meetingId}
に送信します。
一括削除の詳細については、リファレンスドキュメントでご覧いただけます。