Skip to content

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

post

/subscription/status/set

core endpoint

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

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

メールサブスクリプショングループのサンプルまたはテストエンドポイントを表示する場合:

See me in Postman

SMS Subscription 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

{
   "subscription_group_id": (required, string) the id of your subscription group,
   "subscription_state": (required, string) available values are "unsubscribed" (not in subscription group) or "subscribed" (in subscription group),
   "external_id": (required*, array of strings) the external ID of the user or users, may include up to 50 IDs,
   "phone": (required*, array of strings in E.164 format) The phone number of the user (must include at least one phone number and at most 50 phone numbers),
   // SMS subscription group - one of external_id or phone is required
 }

* SMSサブスクリプショングループ:external_id またはphone のみが受け入れられます。

1
2

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

1
2
3
4
5
6
7
8

{
   "subscription_group_id": (required, string) the id of your subscription group,
   "subscription_state": (required, string) available values are "unsubscribed" (not in subscription group) or "subscribed" (in subscription group),
   "external_id": (required*, array of strings) the external ID of the user or users, may include up to 50 IDs,
   "email": (required*, array of strings) the email address of the user (must include at least one email and at most 50 emails),
   // Email subscription group - one of external_id or email is required
   // Note that sending an email address that is linked to multiple profiles will update all relevant profiles
 }

* 電子メールサブスクリプショングループ:email またはexternal_id のいずれかが必要です。

このプロパティは、ユーザーのプロファイル情報の更新には使用しないでください。代わりに、/users/trackプロパティを使用します。

リクエストパラメーター

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

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

リクエスト例

メール

1
2
3
4
5
6
7
8
9
10

curl --location --request POST 'https://rest.iad-01.braze.com/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_group_id": "subscription_group_identifier",
  "subscription_state": "unsubscribed",
  "external_id": "external_identifier",
  "email": ["example1@email.com", "example2@email.com"]
}
'

SMS

1
2
3
4
5
6
7
8
9
10

curl --location --request POST 'https://rest.iad-01.braze.com/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_group_id": "subscription_group_identifier",
  "subscription_state": "unsubscribed",
  "external_id": "external_identifier",
  "phone": ["+12223334444", "+11112223333"]
}
'

成功応答の例

ステータス コード201は、以下のレスポンスボディを返す可能性があります。

1
2
3

{
    "message": "success"
}
Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!