各エンドポイントで指定するパラメーターについて

以下APIエンドポイントを利用することで、特定のメールアドレスのサブスクリプションタイプのステータスを自動変更したいと考えております。

自動変更の実現可能性を確認したく、本エンドポイントで指定する以下パラメーターについて、ご存知の方、教えていただけませんでしょうか?><

どうぞよろしくお願い致します。

---------------------------------------------------------------------------------------

▼APIエンドポイント

配信設定v3 - HubSpot docs

▼パラメーター

・subscriptionId

HubSpot上のどの項目のIDを指定するか

・legalBasis

各選択肢による挙動の違い

@nakamura2
GDPRについて詳しくはないのですが、APIを散々叩いているので回答させていただきます。
GETで
https://api.hubapi.com/communication-preferences/v3/status/email/{emailAddress}
または
https://api.hubapi.com/communication-preferences/v3/definitions
のエンドポイントを叩いたリターンのプロパティ名"id"の部分でIDが確認できます。

または設定→ツール→マーケティング→Eメールといくとございますが、UIではIDまでは確認できないようです。
GDPRについては、以下の記事を参考にした限りですが、

https://knowledge.hubspot.com/jp/contacts/how-can-i-track-lawful-basis-of-processing-in-hubspothttps://knowledge.hubspot.com/jp/contacts/how-do-subscription-preferences-and-types-work
GDPR、配信設定などは、後で何かあった際の法的根拠・同意を追跡/設定するためのもので、

  • GDPR有効がオンになっていると、サブスクタイプとその同意=Onのないコンタクトにメール配信できなくなります。
  • legalbasisについては、基本的にはフォームまたは配信していいかどうか伺う配信で回収するものですが、手動またはAPIで更新するときに御社がどういうコミュニケーションに基づいてそのコンタクトの配信を設定する定義になるのか、法務の方と相談して特定いただくものかと存じます。

つまり、挙動に変わりはあるかと言われると、オンになっている&有効なサブスクタイプが設定されている限り、変わらないはずです。
@natsumimori さん、上記理解で合ってますでしょうか??

@KMurota さん、

ご回答ありがとうございます!
以下だと認識しましたm( )m

また何かございましたら回答いただければ幸いです。
引き続きどうぞよろしくお願い致します。

-----------------------------------------------------------------
▼subscriptionId
⇒・サブスクリプションタイプに付与されている
・画面上で確認することはできない
・GET https://api.hubapi.com/communication-preferences/v3/status/email/{emailAddress}

で取得できる

▼legalBasis
⇒・法的根拠・同意を追跡/設定するためのもの
・GDPR有効がオンになっており、有効なサブスクタイプが設定されている限り、
選択肢によって挙動が変わることはない