Skip to content

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

post

/v2/subscription/status/set

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

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

メールサブスクリプショングループの例を確認するか、このエンドポイントをテストするには：

See me in Postman

SMSサブスクリプショングループの例を確認するか、このエンドポイントをテストするには：

See me in Postman

WhatsAppグループの例を確認するか、このエンドポイントをテストするには：

See me in Postman

前提条件

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

V1との違い

V2エンドポイントはV1エンドポイントと以下の点で異なります。

  • 複数のサブスクリプショングループ：V2では、単一のAPIリクエストで複数のサブスクリプショングループを更新できます。一方、V1ではリクエストごとに1つのサブスクリプショングループしかサポートしていません。
  • 1回の呼び出しでメールとSMSの両方を更新：external_ids を使用する場合、同じユーザーに対してメールとSMSの両方のサブスクリプショングループを、単一のAPI呼び出しで更新できます。V1では、メールとSMSのサブスクリプショングループに対して、別々のAPI呼び出しを行う必要があります。
  • メールや電話の識別子を使用する場合：external_ids の代わりに emails または phones を使用する場合、同じリクエストでメールとSMSのサブスクリプショングループの両方を更新することはできません。別々のAPI呼び出しを行う必要があります。メールサブスクリプショングループ用とSMSサブスクリプショングループ用でそれぞれ別々の呼び出しが必要です。

レート制限

このエンドポイントには、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
9
10
11
12

{
  "subscription_groups":[
    {
      "subscription_group_id": (required, string),
      "subscription_state": (required, string),
      "external_ids": (required*, array of strings),
      "emails": (required*, array of strings),
      "phones": (required*, array of strings in E.164 format),
      "use_double_opt_in_logic": (optional, boolean)
    }
  ]
}

リクエストパラメーター

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

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

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

リクエスト例

次の例では、external_ids を使用して単一のAPI呼び出しでメールとSMSのサブスクリプショングループの両方を更新します。これは external_ids を使用する場合にのみ可能です。emails または phones を使用している場合、1回の呼び出しでメールとSMSのサブスクリプショングループの両方を更新することはできません。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

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

メール

1
2
3
4
5
6
7
8
9
10
11
12
13

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

SMSとWhatsApp

1
2
3
4
5
6
7
8
9
10
11
12
13

curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_groups":[
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "phones":["+12223334444","+15556667777"]
    }
  ]
}
'
New Stuff!