会社 

概要エンドポイント

HubSpotの会社レコードには、自社とやり取りする組織に関する情報が保存されます。会社エンドポイントを使用することにより、会社レコードを作成および管理したり、HubSpotと他のシステムの間で会社データを同期したりできます。 

オブジェクト、レコード、プロパティー、および関連付けAPIの詳細については、「CRMについて」のガイドをご確認ください。HubSpotのオブジェクトとレコードに関する一般的な情報については、CRMデータベースを管理する方法をご確認ください。

会社レコードを作成する

新しい会社レコードを作成するには、POSTリクエストを/crm/v3/objects/companiesに送信します。

リクエスト内のpropertiesオブジェクトに会社データを含めます。また、associationsオブジェクトを追加して、新しい会社レコードを既存のレコード（コンタクト、会社など）やアクティビティー（ミーティング、メモなど）に関連付けることもできます。

プロパティー

会社の詳細は、会社プロパティーに保存されます。HubSpotの既定の会社プロパティーがありますが、カスタムプロパティーを作成することもできます。

新しい会社レコードを作成する際は、nameまたはdomainプロパティーのうち、少なくとも1つをリクエストに含める必要があります。ドメイン名は会社を一意に識別する主要なIDであるため、HubSpotで会社レコードが重複しないようにするために、常にdomainを含めることを推奨します。会社が複数のドメインを所有している場合は、hs_additional_domainsフィールドに各ドメインをセミコロンで区切って指定することにより、API経由でドメインを追加できます。例："hs_additional_domains" : "domain.com; domain2.com; domain3.com"

利用可能な全てのプロパティーを確認するには、GETリクエストを/crm/v3/properties/companiesに送信して、アカウントの会社プロパティーのリストを取得します。詳しくはプロパティーAPIをご参照ください。

注：リクエストにlifecyclestageを含めている場合、値はライフサイクルステージの内部名を参照する必要があります。既定のステージの内部名はテキスト値であり、ステージのラベル（subscriberやmarketingqualifiedleadなど）を編集してもこれは変更されません。カスタムステージの内部名は数値です。ステージの内部IDを見つけるには、ライフサイクルステージ設定を確認するか、APIを使ってライフサイクル ステージ プロパティーを取得できます。

例えば、新しい会社レコードを作成する場合、リクエストの内容は次のようになります。

///Example request body { "properties": { "name": "HubSpot", "domain": "hubspot.com", "city": "Cambridge", "industry": "Technology", "phone": "555-555-555", "state": "Massachusetts", "lifecyclestage": "51439524" } }

関連付け

新しい会社レコードを作成する際に、その会社を既存のレコードやアクティビティーに関連付けることもできます。associationsオブジェクトに、次のフィールドを含めます。

Use this table to describe parameters / fields
ParameterDescription
toObjectId

会社を関連付けるレコードまたはアクティビティーのID。

associationTypeId

会社と他のオブジェクトまたはアクティビティーとの関連付けタイプを示す一意の識別子。既定の関連付けタイプは、ここにリストされています。または、GETリクエストを/crm/v4/associations/{fromObjectType}/{toObjectType}/labelsに送信して値を取得できます。詳しくは関連付けAPIをご確認ください。

labelフィールドを含めて、関連付けを説明する定義済み関連付けラベルを割り当てることもできます。レコードを関連付ける方法については関連付けAPIをご確認ください。

例えば、新しい会社レコードに既存のコンタクトとEメールアドレスを関連付ける場合、リクエストの内容は次のようになります。

///Example request body { "properties": { "name": "HubSpot", "domain": "hubspot.com", "city": "Cambridge", "industry": "Technology", "phone": "555-555-555", "state": "Massachusetts", "lifecyclestage": "51439524" }, "associations": [ { "to": { "id": 101 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 280 } ] }, { "to": { "id": 556677 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 185 } ] }] }

会社レコードを取得する

会社レコードを個別に、または一括で取得できます。

  • 個々の会社レコードを取得するには、GETリクエストを/crm/v3/objects/companies/{companyId}に送信します。
  • 全ての会社レコードのリストを取得するには、GETリクエストを/crm/v3/objects/companiesに送信します。

これらのエンドポイントに対し、リクエストのURLに次のクエリーパラメーターを含めることができます。 

Use this table to describe parameters / fields
ParameterDescription
properties

レスポンスで取得するプロパティーのカンマ区切りリスト。リクエスト対象の会社レコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。

propertiesWithHistory

レスポンスで取得する現在および過去のプロパティーのカンマ区切りリスト。リクエスト対象の会社レコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。

associations

関連付けられているIDが取得されるオブジェクトの、カンマ区切りリスト。存在しない関連付けを指定した場合、その関連付けはレスポンスで返されません。詳しくは関連付けAPIをご参照ください。
  • レコードIDまたはカスタムの固有の識別子のプロパティーを指定して、特定の会社レコードを一括で取得するには、crm/v3/objects/companies/batch/readに対してPOSTリクエストを送信します。このバッチエンドポイントは関連付けを取得できません。関連付けAPIを使用してバッチが関連付けを読み取る方法について説明します。

一括読み取りエンドポイントの場合は、任意指定のidPropertyパラメーターを使用し、カスタムの固有の識別子のプロパティーを指定して、会社レコードを取得することもできます。既定で、リクエストのid値はレコード ID（hs_object_id）を表すので、レコードIDを使用して取得する場合はidPropertyパラメーターは不要です。カスタムの固有の値のプロパティーを使用して会社レコードを取得する場合は、idPropertyパラメーターを含める必要があります。

例えば、会社レコードを一括で取得する場合のリクエストは、次のいずれかのようになります。

///Example request body with record ID { "properties": [ "name", "domain" ], "inputs": [ { "id": "56789" }, { "id": "23456" } ] }
///Example request body with a unique value property { "properties": [ "name", "domain" ], "idProperty": "uniquepropertyexample", "inputs": [ { "id": "abc" }, { "id": "def" } ] }

プロパティーの現在の値と過去の値を含む会社を取得する場合のリクエストは、次のようになります。

///Example request body with record ID (current and historical values) { "propertiesWithHistory": [ "name" ], "inputs": [ { "id": "56789" }, { "id": "23456" } ] }

会社レコードを更新する

会社レコードを個別に、または一括で更新できます。既存の会社の場合、APIを介して会社レコードを更新するために使用可能な一意の値は、会社のレコードIDです。

会社IDを基準に個々の会社レコードを更新するには、PATCHリクエストを/crm/v3/objects/companies/{companyId}にして、更新するデータを含めます。

既存の会社レコードを他のレコードまたはアクティビティーに関連付ける

会社レコードを他のCRMレコードまたはアクティビティーに関連付けるには、PUTリクエストを/crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}に送信します。

associationTypeId値を取得するには、この既定値リストを参照するか、GETリクエストを/crm/v4/associations/{fromObjectType}/{toObjectType}/labelsに送信します。

レコードを関連付ける方法について詳しくは関連付けAPIご確認ください。

関連付けを削除する

会社レコードと他のレコードまたはアクティビティーの関連付けを削除するには、DELETEリクエストを/crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}に送信します。

会社レコードでアクティビティーをピン留めする

リクエストにhs_pinned_engagement_idフィールドを含めると、APIを介して会社レコードでアクティビティーをピン留めできます。フィールドに、ピン留めするアクティビティーのIDを含めます。これは、エンゲージメントAPIを介して取得できます。レコードごとに1つのアクティビティーをピン留めすることができ、そのアクティビティーはピン留めする前にすでに会社レコードに関連付けられている必要があります。

会社のピン留めされたアクティビティーを設定または更新するには、次のようにリクエストします。

///Example request body PATCH /crm/v3/objects/companies/{companyId} { "properties": { "hs_pinned_engagement_id": 123456789 } }

会社を作成し、既存のアクティビティーに関連付け、同じリクエストにアクティビティーをピン留めすることもできます。例として、以下のような場合が挙げられます。

///Example request body POST /crm/v3/objects/companies { "properties": { "domain": "example.com", "name": "Example Company", "hs_pinned_engagement_id": 123456789 }, "associations": [ { "to": { "id": 123456789 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 189 }] }] }

会社レコードを削除する

会社レコードを個別に、または一括で削除できます。削除した会社レコードは、HubSpot内のごみ箱に追加されます。そのため、必要に応じて後でHubSpot内で会社レコードを復元できます。

IDを基準に個々の会社レコードを削除するには、DELETEリクエストを/crm/v3/objects/companies/{companyId}に送信します。

会社レコードを一括で削除する方法については、この記事の上部にある［エンドポイント］タブをクリックしてください。

参考になりましたか？
こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。