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呼び出しで更新できる。バージョン1では、メールとSMSのサブスクリプショングループに対して、別々のAPI呼び出しを行う必要がある。
  • メールや電話の識別子を使用する：またはphonesの代わりにemailsを使用external_idsする場合、同じリクエストでメールとSMSのサブスクリプショングループの両方を更新することはできない。別々のAPI呼び出しを行う必要がある。メールサブスクリプショングループ用とSMSサブスクリプショングループ用でそれぞれ別々の呼び出しだ。

レート制限

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

Request body

1
2

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

1
2
3
4
5
6
7
8
9
10
11

{
  "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),
    }
  ]
}

リクエストパラメーター

例のリクエスト

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

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!