会社レコードには、企業に関するデータを格納します。会社エンドポイントを使用することにより、会社データを管理したり、HubSpotと他のシステムとの間で同期したりできます。
POST
リクエストを/crm/v3/objects/companies
に送信します。
リクエスト内のpropertiesオブジェクトに会社データを含めます。また、associationsオブジェクトを追加して、新しい会社レコードを既存のレコード(コンタクト、取引など)やアクティビティー(ミーティング、メモなど)に関連付けることもできます。
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を使ってライフサイクル ステージ プロパティーを取得します。パラメーター | 説明 |
---|---|
to | 会社レコードを関連付けるレコードまたはアクティビティー。一意のid 値で指定します。 |
types | 会社とレコード/アクティビティーの間の関連付けのタイプ。associationCategory およびassociationTypeId を含めます。デフォルトの関連付けタイプIDは、このページで確認できます。または、関連付けAPIを使用して、カスタム関連付けタイプ(ラベル)の値を取得することもできます。 |
GET
リクエストを/crm/v3/objects/companies/{companyId}
に送信します。GET
リクエストを/crm/v3/objects/companies
に送信します。パラメーター | 説明 |
---|---|
properties | レスポンスで返されるプロパティーのカンマ区切りリスト。リクエスト対象の会社レコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。 |
propertiesWithHistory | レスポンスで返される現在および過去のプロパティーのカンマ区切りリスト。リクエスト対象の会社レコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。 |
associations | 関連付けられているIDが取得されるオブジェクトのカンマ区切りリスト。存在しない関連付けを指定した場合、その関連付けはレスポンスで返されません。詳しくは関連付けAPIをご参照ください。 |
POST
リクエストをcrm/v3/objects/companies/batch/read
に送信します。このバッチエンドポイントは関連付けを取得できません。関連付けAPIを使用して関連付けを一括で読み取る方法について説明します。idProperty
パラメーターを使用し、カスタムの固有IDプロパティーを指定して、会社レコードを取得することもできます。デフォルトで、リクエストのid
値はレコードID(hs_object_id
)を参照するため、レコードIDを使って取得するときにはidProperty
パラメーターは不要です。カスタムの固有の値のプロパティーを使用して会社レコードを取得するには、idProperty
パラメーターを含める必要があります。
例えば、会社レコードを一括で取得する場合のリクエストは、次のいずれかのようになります。
プロパティーの現在の値と過去の値を含む会社を取得する場合のリクエストは、次のようになります。
PATCH
リクエストに更新対象のデータを含めて/crm/v3/objects/companies/{companyId}
に送信します。
PUT
リクエストを/crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
に送信します。
associationTypeId
値を取得するには、デフォルト値のこのリストを参照するか、GET
リクエストを/crm/v4/associations/{fromObjectType}/{toObjectType}/labels
に送信します。DELETE
リクエストを/crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
に送信します。
hs_pinned_engagement_id
フィールドを含めることで、APIを介して会社レコードでアクティビティーをピン留めできます。フィールドに、ピン留めするアクティビティーのid
を含めます。これはエンゲージメントAPIを介して取得できます。レコードごとに1つのアクティビティーをピン留めすることができ、そのアクティビティーはピン留めする前にすでに会社レコードに関連付けられている必要があります。
会社にピン留めするアクティビティーを設定または更新する場合、リクエストは次のようになります。
DELETE
リクエストを/crm/v3/objects/companies/{companyId}
に送信します。
会社を一括で削除する方法について詳しくは、 リファレンスドキュメントをご確認ください。