最終更新日: 2025年8月22日

Run in Postman

 CRMレコードにメモを記録して、レコードのタイムラインに情報を追加したり、添付ファイルをレコードに関連付けたりすることができます。例えば、コンタクトとのオフラインコミュニケーションを追跡する必要がある場合は、そのコミュニケーションに関連する詳細情報やドキュメントをコンタクトレコードにメモとして追加できます。その後、アカウント内の他のユーザーがそのメモを表示して参照できるようになります。 メモは、HubSpot内で、またはメモAPIを通じて管理できます。この記事では、APIを使用したノートの基本的な管理方法を説明します。利用可能な全てのエンドポイントは、リファレンスドキュメントでご確認いただけます。

​
メモを作成する

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

​
プロパティー

Propertiesオブジェクトには、次のフィールドを含めることができます。
フィールド説明
hs_timestamp必須。このフィールドは、メモの作成時刻を記録し、レコードタイムラインでのそのメモの表示位置を決定します。ミリ秒単位またはUTC形式のUnixタイムスタンプを使用できます。
hs_note_bodyメモのテキストコンテンツ。65,536文字までに制限されています。
hubspot_owner_idメモに関連付けられている担当者のID。このフィールドにより、HubSpotのレコードタイムラインにメモ作成者として表示されるユーザーが決まります。
hs_attachment_idsメモの添付ファイルのID。複数の添付ファイルIDはそれぞれセミコロンで区切られます。

​
関連付け

メモを作成して既存のレコードと関連付けるには、リクエストにassociationsオブジェクトを含めます。例えば、メモを作成して会社と取引に関連付ける場合、リクエスト本文は次のようになります。 
// Example POST request to https://api.hubspot.com/crm/v3/objects/notes
{
  "properties": {
    "hs_timestamp": "2021-11-12T15:48:22Z",
    "hs_note_body": "Spoke with decision maker Carla. Attached the proposal and draft of contract.",
    "hubspot_owner_id": "14240720",
    "hs_attachment_ids": "24332474034;24332474044"
  },
  "associations": [
    {
      "to": {
        "id": 301
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 190
        }
      ]
    },
    {
      "to": {
        "id": 401
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 214
        }
      ]
    }
  ]
}
Associationsオブジェクトには、次のものを含める必要があります。
フィールド説明
toメモに関連付けるレコード。一意のid値で指定します。
typesメモとレコードの間の関連付けのタイプ。associationCategoryおよびassociationTypeIdを含めます。デフォルトの関連付けタイプIDはこちらのページに記載されています。または、関連付けAPIを使用して、カスタムの関連付けタイプ（ラベル）の値を取得することもできます。
メモを一括で作成する方法については、リファレンスドキュメントをご参照ください。

​
メモを取得する

メモを個別に、または一括で取得することができます。個々のメモを取得するには、GETリクエストを/crm/v3/objects/notes/{noteId}に送信します。 全てのメモのリストを取得するには、GETリクエストを/crm/v3/objects/notesに送信します。 どちらのエンドポイントに対しても、リクエストのURLに次のクエリーパラメーターを含めることができます。
パラメーター説明
propertiesレスポンスで返される、プロパティーのカンマ区切りのリスト。リクエスト対象のメモで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。
associations関連付けられているIDが取得されるオブジェクトタイプのカンマ区切りのリスト。存在しない関連付けを指定した場合、その関連付けはレスポンスで返されません。詳しくは関連付けAPIをご参照ください。
例えば、特定のテキストコンテンツおよび関連付けられているコンタクトIDを含むメモを取得する場合、リクエストURLは次のようになります。 https://api.hubapi.com/crm/v3/objects/notes?limit=10&properties=hs_note_body&associations=contact&archived=false 内部IDまたは一意のプロパティー値によってメモを一括で取得する方法については、リファレンスドキュメントをご参照ください。

​
メモを更新する

メモを個別に、または一括で更新することができます。メモIDを指定して個別のメモを更新するには、PATCHリクエストを/crm/v3/objects/notes/{noteId}に送信します。 リクエスト本文には次のように更新するメモプロパティーを含めます。 
// Example PATCH request to https://api.hubspot.com/crm/v3/objects/notes/{noteID}
{
  "properties": {
    "hs_note_body": "Spoke with decision maker Carla.",
    "hs_attachment_ids": "24332474034;24332474044"
  }
}
HubSpotでは、読み取り専用プロパティーおよび存在しないプロパティーの値が無視されます。プロパティー値をクリアするには、リクエストの本文でプロパティーの空の文字列を渡します。 メモを一括で更新する方法については、リファレンスドキュメントをご参照ください。

​
既存のメモをレコードに関連付ける

メモをコンタクトなどの他のCRMレコードに関連付けるには、PUTリクエストを/crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}に送信します。リクエストのURLには次のフィールドが含まれます。
フィールド説明
noteIdメモのID。
toObjectTypeメモに関連付けるオブジェクトのタイプ（コンタクト、会社など）。
toObjectIdメモに関連付けるレコードのID。
associationTypeIdメモと他のオブジェクトとの関連付けタイプを示す一意の識別子。このIDは、数値またはスネークケース（例：note_to_contact）で表すことができます。該当する値は関連付けAPIを介して取得できます。
例えば、リクエストのURLは次のようになります。 https://api.hubspot.com/crm/v3/objects/notes/17147287858/associations/contact/581751/202

​
関連付けを削除する

メモとレコードの間の関連付けを削除するには、上記と同じ以下のURLに対してDELETEリクエストを送信します。 /crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}

​
レコードでメモをピン留めする

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

​
メモを削除する

メモを個別に、または一括で削除することができます。削除したメモは、HubSpot内のごみ箱に追加されます。そのため、後でレコードタイムラインからメモを復元することも可能です。 メモIDを指定して個別のメモを削除するには、DELETEリクエストを/crm/v3/objects/notes/{noteId}に送信します。 メモの削除について詳しくは、リファレンスドキュメントをご参照ください。