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

post

/subscription/status/set

core endpoint

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

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

例を見たり、このエンドポイントをテストしたりする場合は、メールサブスクリプショングループをご覧ください。

See me in Postman

SMSサブスクリプショングループ用のこのエンドポイントをテストするか例を見たい場合:

See me in Postman

前提条件

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

レート制限

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

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

{
   "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

{
   "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プロパティを使用します。

tip:

users/trackエンドポイントを使用して新規ユーザーを作成する際、ユーザー属性オブジェクト内にサブスクリプショングループを設定することができる。これにより、1回のAPIコールでユーザーを作成し、サブスクリプショングループの状態を設定することができる。

リクエストパラメーター

パラメーター	required	データ型	説明
`subscription_group_id`	必須	文字列	サブスクリプショングループの`id`。
`subscription_state`	必須	文字列	使用できる値は、`unsubscribed` (サブスクリプショングループに含まれない) または `subscribed` (サブスクリプショングループに含まれる) です。
`external_id`	必須*	文字列の配列	ユーザーの `external_id` には、最大で 50 個の `id` を含めることができます。
`email`	必須*	文字列または文字列の配列	ユーザーのメールアドレスは、文字列の配列として渡すことができます。少なくとも 1 件のメールアドレス (最大 50件まで) を含める必要があります。同じワークスペース内の複数のユーザー (`external_id`) が同じメールアドレスを共有している場合、そのメールアドレスを共有するすべてのユーザーは、サブスクリプショングループの変更で更新されます。
`phone`	必須*	E.164 形式の文字列	ユーザーの電話番号は文字列の配列として渡すことができます。少なくとも1つの電話番号を含むこと（50件まで）。同じワークスペース内の複数のユーザー(`external_id`)が同じ電話番号を共有している場合、電話番号を共有しているすべてのユーザーが同じサブスクリプショングループの変更で更新される。

例のリクエスト

メール

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 は、次の応答本文を返す可能性があります。

{
    "message": "success"
}

important:

エンドポイントは、email またはphone 値のみを受け入れ、両方を受け入れません。両方を指定した場合、次のレスポンスが返されます。 {"message":"Either an email address or a phone number should be provided, but not both."}

GitHub でこのページを編集

「このページはどの程度役に立ちましたか?」

取得:ユーザーのサブスクリプショングループをリストする

POST:ユーザーのサブスクリプション・グループ・ステータスを更新する V2

GitHub でこのページを編集

New Stuff!