Skip to content

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

post

/v2/subscription/status/set

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

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

メールサブスクリプショングループに対してこのエンドポイントをテストしたり、例を見たりしたい場合：

See me in Postman

SMSサブスクリプション・グループの例を見たい、またはこのエンドポイントをテストしたい場合：

See me in Postman

WhatsApp Groups用のエンドポイントの例を見たい、またはテストしたい：

See me in Postman

前提条件

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

レート制限

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

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

リクエストパラメーター

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

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

リクエスト例

以下の例では、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","example1@email.com"]
    },
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "external_ids":["example-user","example1@email.com"]
    }
  ]
}

メール

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":["example1@email.com","example2@email.com"]
    }
  ]
}
'

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!