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

前提条件

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

レート制限

要求本文:

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

*emails と phones の両方のパラメーターを含めることはできません。また、emails、phones、external_ids はすべて個別に送信できます。

リクエストパラメーター

例のリクエスト

以下の例では、external_id を使って、EメールとSMSのAPIコールを1回行っている。

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!