Skip to content

ユーザーのサブスクリプショングループステータスの更新

post

/subscription/status/set

core endpoint

このエンドポイントを使用して、Brazeダッシュボード上で最大50ユーザーのサブスクリプション状態を一括更新します。

サブスクリプショングループのsubscription_group_idにアクセスするには、サブスクリプショングループページに移動します。

メールサブスクリプショングループの例を確認したり、このエンドポイントをテストしたりする場合:

See me in Postman

SMSとRCSサブスクリプショングループの例を確認したり、このエンドポイントをテストしたりする場合:

See me in Postman

前提条件

このエンドポイントを使用するには、subscription.status.set権限を持つAPIキーが必要です。

Brazeが孤立したサブスクリプション状態を処理する方法

孤立したサブスクリプション状態とは、どのユーザープロファイルにも関連付けられていない電話番号またはメールアドレスに対して保存されたサブスクリプション状態のことです。SMS、メール、WhatsApp、およびLINEについて、Brazeは孤立したサブスクリプション状態を以下のように処理します。

  • ユーザーが削除され、そのユーザーが特定の電話番号またはメールアドレスに関連付けられた唯一のユーザーである場合、その電話番号またはメールアドレスのサブスクリプション状態は即座に削除されます。
  • 現在どのユーザープロファイルにも関連付けられていない電話番号またはメールアドレスを指定して /subscription/status/set または /v2/subscription/status/set を呼び出した場合、Brazeはそのサブスクリプション状態を最大30日間保存し、その後自動的に削除されます。
  • 孤立したサブスクリプション状態が保存されている電話番号またはメールアドレスで新しいユーザープロファイルが作成された場合、そのユーザーは保存されたサブスクリプション状態を継承しますが、30日間の時間枠内に限られます。この30日間の猶予期間は意図的なもので、ユーザーの作成とそのチャネル識別子のサブスクリプション状態の設定が別々のAPI呼び出しで行われる場合の競合を処理するために存在します。この競合の例として、電話番号に対する /subscription/status/set リクエストが、対応するユーザープロファイルを作成する /users/track リクエストよりも先に処理される場合があります。

レート制限

このエンドポイントには、APIレート制限に記載されているように、/subscription/status/set と /v2/subscription/status/set エンドポイント間で共有される1分あたり5,000リクエストのレート制限があります。

リクエスト本文

1
2

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6
7
8

{
   "subscription_group_id": (required, string) the id of your subscription group,
   "subscription_state": (required, string) available values are "unsubscribed" (not in subscription group) or "subscribed" (in subscription group),
   "external_id": (required*, array of strings) the external ID of the user or users, may include up to 50 IDs,
   "phone": (required*, array of strings in E.164 format) The phone number of the user (must include at least one phone number and at most 50 phone numbers),
   "use_double_opt_in_logic": (optional, boolean) defaults to `false`; when `subscription_state` is "subscribed", set to `true` to enter the user into the SMS double opt-in workflow,
   // SMS and RCS subscription group - you must include one of external_id or phone
 }

* SMSとRCSのサブスクリプショングループ: Brazeはexternal_idまたはphoneのみを受け付けます。

このプロパティは、ユーザーのプロファイル情報の更新には使用しないでください。代わりに/users/trackプロパティを使用してください。

リクエストパラメーター

パラメーター 必須 データタイプ 説明
subscription_group_id 必須 文字列 サブスクリプショングループのid。
subscription_state 必須 文字列 使用できる値は、unsubscribed（サブスクリプショングループに含まれない）またはsubscribed（サブスクリプショングループに含まれる）です。
external_id 必須* 文字列の配列 ユーザーのexternal_id。最大50件のidを含めることができます。
email 必須* 文字列または文字列の配列 ユーザーのメールアドレス。文字列の配列として渡すことができます。少なくとも1件のメールアドレス（最大50件）を含める必要があります。

同じワークスペース内の複数のユーザー（external_id）が同じメールアドレスを共有している場合、Brazeはそのメールアドレスを共有しているすべてのユーザーのサブスクリプショングループを更新します。
phone 必須* E.164形式の文字列 ユーザーの電話番号。文字列の配列として渡すことができます。少なくとも1件の電話番号（最大50件）を含める必要があります。

同じワークスペース内の複数のユーザー（external_id）が同じ電話番号を共有している場合、Brazeはその電話番号を共有しているすべてのユーザーを同じサブスクリプショングループの変更で更新します。
use_double_opt_in_logic オプション ブール値 SMSサブスクリプショングループにのみ適用されます。メールやその他のサブスクリプショングループタイプでは無視されます。省略した場合のデフォルトはfalseです。SMSサブスクリプショングループの場合、サブスクリプションステータスがsubscribedに設定されたときにユーザーをSMSダブルオプトインワークフローに入れるにはtrueに設定します。この方法でダブルオプトインワークフローに入ったユーザーは、ワークフローに入った回数に関係なく、1日あたり最大1回のオプトインプロンプト返信メッセージを受信します。このパラメーターが省略されるかfalseに設定された場合、ユーザーはダブルオプトインワークフローを経ずに購読されます。

リクエスト例

メール

1
2
3
4
5
6
7
8
9
10

curl --location --request POST 'https://rest.iad-01.braze.com/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_group_id": "subscription_group_identifier",
  "subscription_state": "unsubscribed",
  "external_id": "external_identifier",
  "email": ["[email protected]", "[email protected]"]
}
'

SMSとRCS

1
2
3
4
5
6
7
8
9
10

curl --location --request POST 'https://rest.iad-01.braze.com/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_group_id": "subscription_group_identifier",
  "subscription_state": "unsubscribed",
  "external_id": "external_identifier",
  "phone": ["+12223334444", "+11112223333"]
}
'

成功応答の例

ステータスコード201は、次の応答本文を返す可能性があります。

1
2
3

{
    "message": "success"
}
New Stuff!