コンテンツにスキップ

APIのユースケース

Braze REST APIは、カスタマーエンゲージメント戦略の管理と最適化を支援するために設計された幅広いエンドポイントを提供します。この記事では、カタログ、メールリストとアドレス、エクスポート、メッセージ、ユーザー設定センター、SMS、サブスクリプショングループ、テンプレート、ユーザーデータなど、各エンドポイントコレクションのユースケースをいくつか紹介します。

各セクションでは、ステップバイステップのガイド、コードサンプル、期待される結果とともにシナリオを紹介します。この記事を読み終わる頃には、カスタマーエンゲージメント活動を強化するためのBraze REST APIの使い方をより深く理解できるようになります。

カタログから複数のアイテムを削除する

新年を迎え、キッチン用品を専門とする小売ブランド Kitchenerie では、新製品のラインナップが始まります。Braze ダッシュボードでは、Kitchenerie は食器コレクション用に「Dishware」というカタログを設定しています。新年にあたり、食器コレクションから以下の製品を削除することになりました。

  • Plain Bisque
  • Pearl Porcelain
  • Pink Shimmer

これらの製品をカタログから削除するために、Kitchenerie は /catalogs/{catalog_name}/items エンドポイントを使用してアイテム ID を渡すことができます。

リクエストの例を以下に示します。




curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/dishware/items' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "items": [
    {"id": "plainbisque"},
    {"id": "pearlporcelain"},
    {"id": "pinkshimmer"}
  ]
}'

このペイロードを送信すると、Braze が Kitchenerie の食器カタログから3つのコレクションを正常に削除したことを確認するレスポンスが返されます。




{
  "message": "success"
}

Brazeのスパムリストからメールを削除する

ストリーミングサービス企業であるMovieCanonでは、開発者チームがメールリストを定期的に監査し、メールキャンペーンを購読しているユーザーを特定・維持する責任を担っています。この監査の一環として、MovieCanonは以下のメールアドレスをスパムリストから削除したいと考えています。

このタスクを実行するために、開発者チームは email.spam.remove 権限を持つAPIキーが必要です。これにより /email/spam/remove エンドポイントを使用できます。このエンドポイントは、Brazeのスパムリストと、MovieCanonのメールサービスプロバイダー（ESP）が管理するスパムリストからメールアドレスを削除します。

このリクエストを送信するには、文字列のメールアドレス、または最大50件のメールアドレスの配列を含めます。削除するメールのリストは50件未満であるため、MovieCanonは以下のリクエストボディでこのタスクを実行できます。




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






{
  "email": ["august.author.example.com","[email protected]","[email protected]","[email protected]","[email protected]"]
}

このペイロードの送信が成功すると、以下のレスポンスでBrazeがMovieCanonのスパムリストからメールを削除したことが確認されます。




{
  "message": "success"
}

すべてのキャンバスを監査する

Siege Valley Health は、10の病院と研究センターを運営し、数千人の患者を抱える病院システムです。マーケティングチームは、Brazeを使用した過去3年間にインフルエンザ予防接種の予約を促すために患者に送信されたキャンバスを比較したいと考えています。また、Siege Valley Health のマーケティングチームは、キャンバスのリストと分析サマリーの両方を素早く効率的に確認する方法も求めています。

以下の例では、Braze ダッシュボードでフィルタリングする代わりに、エンドポイントの組み合わせを使用して、Siege Valley Health がこれら2つのタスクを達成する方法を示します。

キャンバスの監査という最初のタスクでは、/canvas/list エンドポイントを使用して、名前とタグを含むキャンバスのリストをエクスポートします。リクエストの例を以下に示します。

Siege Valley Health のマーケティングチームが受け取るレスポンスは以下のとおりです。



{
  "canvases" : [
  	{
  		"id": "canvas_identifier_1",
  		"last_edited": "2020-07-10T23:59:59",
  		"name": "PatientReminder_FluShot_2020",
  		"tags": {
        "flu_shots", "patienthealth", "2020"
      }
  	},
  	{
  		"id": "canvas_identifier_2",
  		"last_edited": "2020-07-30T23:59:59",
  		"name": "PatientReminder2_FluShot_2020",
  		"tags": {
        "flu_shots", "patienthealth", "reminder", "2020"
      }
  	},
    ... (more Canvases)
  ],
  "message": 'success'
}

次のタスクとして、Siege Valley Health のキャンバスリストの最初のキャンバスの分析サマリーを確認します。これを行うには、以下のリクエストパラメーターを指定して /canvas/data_summary エンドポイントを使用します。

  • canvas_id: “canvas_identifier_2”
  • ending_at: 2023-07-10T23:59:59
  • starting_at: 2020-07-10T23:59:59

リクエストの例を以下に示します。




curl --location -g --request GET 'https://rest.iad-01.braze.com/canvas/data_summary?canvas_id=&ending_at=2023-07-10T23:59:59&starting_at=2020-07-10T23:59:59&length=5&include_variant_breakdown=false&include_step_breakdown=false&include_deleted_step_data=false' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

予定されている今後のキャンペーンとキャンバスの確認

Flash & Thread は、衣料品や美容製品をオンラインおよび店舗で販売する小売ブランドです。一年で最も忙しい時期が急速に近づいています。マーケティングチームは、2024年3月31日午後12時までに予定されている今後のキャンペーンとキャンバスをBrazeダッシュボードから確認したいと考えています。これは /messages/scheduled_broadcasts エンドポイントを使用して実現できます。

リクエストの例を以下に示します。




curl --location --request GET 'https://rest.iad-01.braze.com/messages/scheduled_broadcasts?end_time=2024-03-31T12:00:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

このエンドポイントは、今後予定されているキャンペーンとキャンバスのリストを返します。マーケティングチームは、レスポンス内のキャンペーンとキャンバスの name フィールドを参照することで、メッセージのリストを確認できます。

過去のユーザー設定センターを表示する

PoliterWeekly はメールでサブスクライバーにリーチするデジタルマガジンです。マーケティングチームはサブスクライバーのユーザージャーニーをより深く理解するために、PoliterWeekly のユーザー設定センターの詳細を確認し、作成日時と最終更新日時を把握したいと考えています。

/preference_center/v1/{preferenceCenterExternalID} エンドポイントを使用すれば、マーケティングチームはユーザー設定センターの外部 ID をパスパラメーターとして挿入するだけで済みます。リクエストは次のようになります。




curl --location -g --request GET https://rest.iad-01.braze.com/preference_center/v1/politer_weekly_preference_center_api_id \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
PoliterWeekly のマーケティングチームが受け取るレスポンスは次のとおりです。



{
  "name": "PoliterWeekly Notification Preferences",
  "preference_center_api_id": "user_engage_pref_123",
  "created_at": "2021-04-03T12:00:00",
  "updated_at": "2024-08-15T15:00:00",
  "preference_center_title": "Manage Your PoliterWeekly Notification Preferences",
  "preference_center_page_html": "<!DOCTYPE html><html><head><title>Your PoliterWeekly Newsletter Preferences</title><style>body { font-family: Arial, sans-serif; margin: 0; padding: 20px; }.container { max-width: 600px; margin: auto; }h1 { color: #333; }.preference { margin-bottom: 20px; }.preference label { font-size: 16px; }.preference input[type=\"checkbox\"] { margin-right: 10px; }.submit-btn { background-color: #007bff; color: white; padding: 10px 20px; border: none; cursor: pointer; }</style></head><body><div class=\"container\"><h1>Manage your notification preferences</h1><p>Select the types of updates you wish to receive from us:</p><form id=\"preferencesForm\"><div class=\"preference\"><label><input type=\"checkbox\" name=\"newsUpdates\" checked> News Updates</label></div><div class=\"preference\"><label><input type=\"checkbox\" name=\"editorialPicks\"> Editorial Picks</label></div><div class=\"preference\"><label><input type=\"checkbox\" name=\"events\"> Events & Webinars</label></div><div class=\"preference\"><label><input type=\"checkbox\" name=\"specialOffers\"> Special Offers & Promotions</label></div><button type=\"submit\" class=\"submit-btn\">Save Preferences</button></form></div><script>document.getElementById('preferencesForm').addEventListener('submit', function(e) {e.preventDefault();alert('Your preferences have been saved!');});</script></body></html>",
  "confirmation_page_html": "<!DOCTYPE html><html><head><title>PoliterWeekly Preferences Updated</title></head><body><h1>You're good to go!</h1><p>Braze updated your preferences successfully.</p></body></html>",
  "redirect_page_html": null,
  "preference_center_options": {
    "meta-viewport-content": "width=device-width, initial-scale=1"
  },
  "state": "active"
}

このレスポンスから、マーケティングチームはユーザー設定センターが最終更新の3年前に作成されたことがわかります。この情報をもとに、マーケティングチームは新しいユーザー設定センターを作成して公開できます。

無効な電話番号の削除

CashBlastrでは、迅速な送金と受取を効率化することを主な目標としています。金融サービス企業として、CashBlastrは顧客の電話番号リストを最新かつ正確に保つことを重視しています。開発チームは、マーケティングチームのSMSメッセージが適切なCashBlastrの顧客に届くよう、「無効」とマークされた以下の電話番号リストを削除するよう指示されています。

  • 12223135467
  • 12183095514
  • 14235662245
  • 14324567892

/sms/invalid_phone_numbers/remove エンドポイントでリクエストを送信するには、電話番号を e.164 形式の文字列の配列として指定する必要があり、1回のリクエストにつき最大50件の電話番号を含めることができます。このリストは50件を超えていないため、CashBlastrの開発チームが送信するリクエストボディの例を以下に示します。




Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "phone_numbers": ["12183095514","14255551212"]
}

このペイロードを送信すると、BrazeがCashBlastrの無効な電話番号をBrazeの無効リストから削除したことを確認するレスポンスが返されます。




{
  "message": "success"
}

ユーザーの購読グループステータスを確認する

SandwichEmperor は米国のクイックサービスレストランチェーンであり、同社のマーケティングチームは、ランダムに選んだユーザーリストの SMS 購読グループステータスを確認したいと考えています。/subscription/status/get エンドポイントを使用することで、SandwichEmperor は以下のリクエスト例のように、個々のユーザーに対してこのタスクを実行できます。




curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&phone=+11232223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

このエンドポイントでは、メールに対するユーザーの購読グループステータスも一覧表示できます。複数のユーザーの購読グループステータスを確認する際にもご利用ください。

メールメッセージング用のHTMLテンプレートを確認する

WorkFriendsは、異なる業界の働く人々のつながりを支援するソーシャルネットワークで、マーケティングチームがユーザーにメールキャンペーンを送信する役割を担っています。これらのキャンペーンには、地域イベントのリマインダー、週刊ニュースレター、プロフィールアクティビティのハイライトなどが含まれます。

このシナリオでは、WorkFriendsは以前のブランディングを使った単一のHTMLテンプレートを長年使用してきました。ブランドアイデンティティを統一する取り組みの一環として、WorkFriendsは新しいテンプレートに移行する前に、このHTMLテンプレートに活用できる有用な情報がないかを確認したいと考えています。

WorkFriendsチームが受け取るレスポンスは以下のとおりです。



{
  "email_template_id": "WorkFriends_Email_Template_ID",
  "template_name": "Promo template",
  "description": "Promo template",
  "subject": "WorkFriends Weekly Newsletter",
  "preheader": "Another week, another WorkFriends update",
  "body": "<!DOCTYPE html><html><head><title>WorkFriends Weekly Newsletter</title><style>body {font-family: Arial, sans-serif; color: #333;}.container {padding: 20px;}.header {background-color: #f2f2f2; padding: 10px; text-align: center;}.content {margin-top: 20px;}.footer {margin-top: 20px; font-size: 12px; text-align: center; color: #777;}</style></head><body><div class=\"container\"><div class=\"header\"><h2>WorkFriends Weekly Newsletter</h2></div><div class=\"content\"><p>Hello WorkFriends,</p><p>Welcome to another edition of our weekly newsletter. We've got some exciting updates and promos for you this week!</p><!-- Add more content here --><p>Don't forget to check out our latest promos and updates. Stay connected, stay informed!</p></div><div class=\"footer\"><p>Thank you for being a part of WorkFriends.</p><p>Unsubscribe | Update Preferences</p></div></div></body></html>",
  "tags": "promo",
  "created_at": "2020-07-10 13:00:00.000",
  "updated_at": "2024-02-04 17:00:00.000"
}

このテンプレート情報を確認した後、WorkFriendsは/templates/email/update エンドポイントを使用して、API経由でメールテンプレートを更新することもできます。Brazeダッシュボードのメールテンプレートにこれらの編集内容が反映されます。

Brazeカスタマーエンゲージメントプラットフォームのドキュメント。

リソース
法的情報
会社情報
© 2026 Braze, Inc. All rights reserved.
Braze ステータスの確認
New Stuff!