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)
    }
  ]
}

リクエストパラメーター

リクエスト例

次の例では、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"]
    }
  ]
}
'
Github   GitHub でこのページを編集
New Stuff!