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

Run in Postman

 ミーティングエンゲージメントAPIを使用して、CRMレコードのミーティングを記録および管理できます。ミーティングアクティビティーは、HubSpot内で、またはミーティングAPIを使用して記録できます。レコードに手動で記録されたミーティング、ミーティングツールを使用して設定されたミーティング、またはGoogle カレンダーやMicrosoft 365カレンダーとの連携を使用して設定されたミーティングのエンゲージメントを取得、更新、削除できます。 この記事では、APIを使用したミーティングの基本的な管理方法を説明します。利用可能な全てのエンドポイントとそれぞれの要件については、リファレンスドキュメントでご覧いただけます。

​
ミーティングを作成する

ミーティングエンゲージメントを作成するには、POSTリクエストを/crm/v3/objects/meetingsに送信します。 リクエスト本文で、propertiesオブジェクト内にミーティングの詳細を追加します。また、associationsオブジェクトを追加して、新しいミーティングを既存のレコード（コンタクト、会社など）に関連付けることもできます。

​
プロパティー

Propertiesオブジェクトには、次のフィールドを含めることができます。
フィールド説明
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はそれぞれセミコロンで区切られます。

​
関連付け

ミーティングを作成して既存のレコードと関連付けるには、リクエストにassociationsオブジェクトを含めます。例えば、ミーティングを作成してコンタクトと関連付ける場合、リクエストの内容は次のようになります。 
// Example request body
{
  "properties": {
    "hs_timestamp": "2021-03-23T01:02:44.872Z",
    "hubspot_owner_id": "11349275740",
    "hs_meeting_title": "Intro meeting",
    "hs_meeting_body": "The first meeting to discuss options",
    "hs_internal_meeting_notes": "These are the meeting notes",
    "hs_meeting_external_url": "https://Zoom.com/0000",
    "hs_meeting_location": "Remote",
    "hs_meeting_start_time": "2021-03-23T01:02:44.872Z",
    "hs_meeting_end_time": "2021-03-23T01:52:44.872Z",
    "hs_meeting_outcome": "SCHEDULED"
  },
  "associations": [
    {
      "to": {
        "id": 101
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 200
        }
      ]
    },
    {
      "to": {
        "id": 102
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 200
        }
      ]
    }
  ]
}
Associationsオブジェクトには、以下を含める必要があります。
フィールド説明
toミーティングに関連付けるレコード。一意のid値で指定します。
typesミーティングとレコードの間の関連付けのタイプ。associationCategoryとassociationTypeIdを含めます。デフォルトの関連付けタイプIDはこちらのページに記載されています。または、関連付けAPIを使用して、カスタム関連付けタイプ（ラベル）の値を取得することもできます。
ミーティングの一括作成の詳細については、リファレンスドキュメントでご覧いただけます。

​
ミーティングを取得する

ミーティングを個別に、または一括で取得することができます。一括取得の詳細については、リファレンスドキュメントでご覧いただけます。 ミーティングIDで個別のミーティングを取得するには、GETリクエストを/crm/v3/objects/meetings/{meetingId}に送信します。また、リクエストのURLには次のパラメーターを含めることができます。
パラメーター説明
properties返されるプロパティーのカンマ区切りリスト。
associations関連付けられたレコードIDの取得元となるオブジェクトのカンマ区切りリスト。
全てのミーティングのリストを取得するには、GETリクエストをcrm/v3/objects/meetingsに送信します。リクエストのURLには、次のパラメーターを含めることができます。
パラメーター説明
limitページごとに表示する結果の最大数。
properties返されるプロパティーのカンマ区切りリスト。

​
ミーティングを更新する

ミーティングを個別に、または一括で更新することができます。ミーティングIDを指定して個別のミーティングを更新するには、PATCHリクエストを/crm/v3/objects/meetings/{meetingId}に送信します。 リクエスト本文に、更新するミーティングプロパティーを含めます。例えば、リクエスト本文は次のようになります。 
//Example PATCH request to https://api.hubspot.com/crm/v3/objects/meetings/{meetingId}
{
  "properties": {
     "hs_timestamp": "2019-10-30T03:30:17.883Z",
     "hubspot_owner_id": "11349275740",
     "hs_meeting_title": "Intro meeting",
     "hs_meeting_body": "The first meeting to discuss options",
     "hs_internal_meeting_notes": "These are the meeting notes",
     "hs_meeting_external_url":
     "https://Zoom.com/0000",
     "hs_meeting_location": "Remote",
     "hs_meeting_start_time": "2021-03-23T01:02:44.872Z",
     "hs_meeting_end_time": "2021-03-23T01:52:44.872Z",
     "hs_meeting_outcome": "SCHEDULED"
  }
}'
HubSpotは、読み取り専用プロパティーおよび存在しないプロパティーの値を無視します。プロパティー値をクリアするには、リクエストの本文でプロパティーの空の文字列を渡します。 一括更新の詳細については、リファレンスドキュメントでご覧いただけます。

​
既存のミーティングをレコードに関連付ける

ミーティングをレコード（コンタクトや、コンタクトに関連付けられている会社など）に関連付けるには、PUTリクエストを/crm/v3/objects/meetings/{meetingId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}に送信します。リクエストのURLは次のフィールドからなります。
フィールド説明
meetingIdミーティングのID。
toObjectTypeミーティングに関連付けるオブジェクトのタイプ（コンタクト、会社など）。
toObjectIdミーティングに関連付けるレコードのID。
associationTypeIdミーティングと他のオブジェクトタイプとの間の関連付けタイプのID。この値は関連付けAPIを介して取得できます。
例えば、リクエストのURLは次のようになります。 https://api.hubspot.com/crm/v3/objects/meetings/17612479134/associations/contact/104901/200

​
関連付けを削除する

ミーティングとレコードの間の関連付けを削除するには、上記と同じURLに対してDELETEリクエストを送信します。 /crm/v3/objects/meetings/{meetingId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}

​
レコードでミーティングをピン留めする

レコードでミーティングをピン留めして、レコードのタイムラインの上部に常に表示されるようにすることができます。ピン留めする前に、ミーティングが既にレコードに関連付けられている必要があり、1つのレコードにつき1つのアクティビティーのみをピン留めできます。ミーティングをピン留めするには、オブジェクトAPIを介してレコードを作成または更新するときに、hs_pinned_engagement_idフィールドにミーティングのidを含めます。会社、コンタクト、取引、チケット、およびカスタムオブジェクトAPIの使用の詳細については、こちらをご覧ください。

​
ミーティングを削除する

ミーティングを個別に、または一括で削除することができます。削除したミーティングは、HubSpot内のごみ箱に追加されます。そのため、必要に応じて後でレコードタイムラインからミーティングを復元することも可能です。 ミーティングIDを指定して個別のミーティングを削除するには、DELETEリクエストを/crm/v3/objects/meetings/{meetingId}に送信します。 一括削除の詳細については、リファレンスドキュメントでご覧いただけます。
Last modified on December 10, 2025