ユーザーリレーションシップを一括削除
/data_objects/user_relationships
このエンドポイントを使用して、1回のリクエストで最大50件のユーザーとオブジェクトのリレーションシップを削除します。

Data Objectsは一般提供されていますが、このエンドポイントを使用するには、ワークスペースでAccountsがプロビジョニングされている必要があります。プロビジョニングをリクエストするには、データ設定 > アカウント に移動し、アンケートに回答してください。詳細については、Accountsを有効にするを参照してください。
Brazeはリクエストを受け付け、バックグラウンドで処理します。202 応答は、バッチがキューに追加されたことを意味し、適用済みであることを意味するものではありません。1件のリレーションシップを削除してすぐに変更を確認するには、ユーザーリレーションシップを削除を使用してください。それぞれの使い分けについては、一括エンドポイントを参照してください。
前提条件
このエンドポイントを使用するには、data_objects.user_relationships.bulk_delete 権限を持つ API キーが必要です。data_objects.user_relationships.delete などの単一レコード用の権限では、このエンドポイントにアクセスできません。
レート制限
このエンドポイントはData Objectsの一括書き込みバケットに属しており、デフォルトの制限はワークスペースあたり毎分1,000リクエストです。この制限は6つの一括エンドポイントすべて、およびデータオブジェクトの Cloud Data Ingestion 同期で共有され、単一レコードの書き込み制限とは別に管理されます。
リクエストパラメーター
次の表に、/data_objects/user_relationships エンドポイントの JSON リクエスト本文パラメーターとその説明を示します。
| パラメーター | 必須 | データタイプ | 説明 |
|---|---|---|---|
records |
必須 | 配列 | 削除するユーザーリレーションシップ。1~50件のレコードを含める必要があります。Brazeはその他のトップレベルフィールドを拒否します。 |
records[].type_name |
必須 | 文字列 | ユーザーがリンクされているオブジェクトのタイプ |
records[].object_id |
必須 | 文字列 | ユーザーがリンクされているオブジェクトの識別子 |
records[].rel_kind |
必須 | 文字列 | リレーションシップタイプの名前 |
records[].user |
必須 | オブジェクト | リンクされているユーザー。external_id、braze_id、email、phone、alias のいずれか1つだけを含める必要があります。0個または2個以上を送信するとエラーになります。 |
records[].user.external_id |
オプション | 文字列 | ユーザーの external ID |
records[].user.braze_id |
オプション | 文字列 | Brazeのユーザー ID |
records[].user.email |
オプション | 文字列 | ユーザーのメールアドレス |
records[].user.phone |
オプション | 文字列 | ユーザーの電話番号 |
records[].user.alias |
オプション | オブジェクト | alias_name と alias_label を含むユーザーエイリアスオブジェクト (使用する場合は両方とも必須) |
メールアドレスまたは電話番号が複数のユーザーに一致する場合、Brazeの標準的なプロファイル選択ルールに従って、影響を受けるユーザーが決まります。
Braze によるバッチの処理方法
- 検証はオールオアナッシングです。いずれかのレコードが検証に失敗すると、Brazeはリクエスト全体を
400で拒否し、何も保存せず、すべてのエラーを一覧表示します。エラーを修正して、リクエスト全体を再送信してください。 - 検索は処理中に行われます。Brazeはバッチの処理時にタイプ、リレーションシップタイプ、オブジェクト、ユーザー、リレーションシップが存在するかどうかを確認するため、
202を返したリクエストでも、後から個々のレコードで失敗が発生する場合があります。処理エラーを参照してください。 - レコードは受信時刻順に処理されます。Brazeはすべてのレコードにリクエストの受信時刻を付与するため、
updated_atは送信しないでください。これを含むリクエストは Braze によって拒否されます。2つのリクエストが同じリレーションシップを変更する場合、Brazeが後に受信したリクエストが優先され、その後に到着した古い書き込みはスキップされます。 - 削除は待機する場合があります。まだ存在しないリレーションシップの削除は、すぐに失敗せずに待機します。Brazeは約40時間 (10回) 再試行します。それでもリレーションシップが存在しない場合、そのレコードは
data-object-dependency-not-foundで失敗します。
リクエスト例
このセクションには、JSON ペイロードのサンプルと cURL リクエストのサンプルが含まれています。
リクエストペイロードのサンプル
{
"records": [
{"type_name": "account", "object_id": "acct-001", "rel_kind": "owns", "user": {"external_id": "user-1"}}
]
}
cURL リクエストのサンプル
この例では、external IDが user-1 のユーザーと acct-001 の間の owns リレーションシップを削除します。ユーザープロファイルとアカウントレコードはどちらも残ります。
curl --location --request DELETE 'https://rest.iad-01.braze.com/data_objects/user_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"records": [
{"type_name": "account", "object_id": "acct-001", "rel_kind": "owns", "user": {"external_id": "user-1"}}
]
}'
応答
このセクションには、成功応答のサンプルと応答フィールドが含まれています。
成功応答の例
ステータスコード 202 は、次の応答本文を返す可能性があります。
{
"source_import_id": "api-20261022T153012123456-9f3a1c2b",
"status": "queued",
"record_count": 1
}
応答パラメーター
次の表に、成功応答のフィールドとその説明を示します。
| パラメーター | 必須 | データタイプ | 説明 |
|---|---|---|---|
source_import_id |
必須 | 文字列 | Brazeがこのリクエストに対して生成した識別子。各リクエストはそれぞれ独立したインポートです。 |
status |
必須 | 文字列 | 常に queued です。バッチは受け付けられ、処理待ちの状態です。 |
record_count |
必須 | 整数 | リクエスト内のレコード数 |
処理エラー
Brazeはこれらのコードをエンドポイントから返しません。キューに入ったバッチを処理する際に、個々のレコードに対して記録します。
| コード | 意味 |
|---|---|
data-object-type-not-found |
type_name がワークスペース内のアクティブなタイプを指していません。 |
data-object-relationship-type-not-found |
rel_kind がこのタイプのアクティブなリレーションシップタイプを指していません。 |
data-object-invalid-user-identifier |
ユーザー識別子を使用してユーザーを見つけることができません。 |
data-object-ingestion-rejected |
その他の拒否。 |
data-object-dependency-not-found |
約40時間の再試行後も、リレーションシップが見つかりませんでした。 |
エラー
400 応答は、Brazeが何も保存しなかったことを意味します。各エラーには id、message、該当する場合は問題のある parameter、レコードレベルのエラーの場合はレコードの index (records 内の0から始まる位置) が含まれます。parameter には、user.external_id のように、リクエストで使用した名前が使われます。
次の表に、このエンドポイントでよく発生するエラーとその解決方法を示します。
| ステータス | 原因 | ガイダンス |
|---|---|---|
400 |
無効なリクエスト (invalid-request): 本文が JSON オブジェクトでないか、JSON の形式が不正である、records がないかエントリ数が1未満または50を超えている、あるいは本文にBrazeが設定するフィールド (source_type、source_import_id、source_chunk_id、record_type) が含まれている |
records のみをフィールドとし、1~50件のレコードを含む JSON オブジェクトを送信してください。 |
400 |
スキーマの不一致 (schema-mismatch): レコードに必須フィールドがない、認識されないフィールド (updated_at を含む) がある、フィールドの型が間違っているか空の文字列である、または user オブジェクトに複数の識別子がある |
一覧表示されたすべてのレコードを修正し、リクエスト全体を再送信してください。 |
400 |
ユーザー識別子がない (missing-user-identifier): レコードの user に識別子がない |
各レコードの user に識別子を1つだけ送信してください。 |
401 |
REST API キーがないか無効 | Authorization ヘッダーで Bearer YOUR_REST_API_KEY が使用されていること、およびキーがアクティブであることを確認してください。 |
403 |
API キーに権限がないか、リクエストが許可リストによってブロックされている | キーに data_objects.user_relationships.bulk_delete 権限があること、および設定されている場合は送信元IPがキーの許可リストに含まれていることを確認してください。 |
404 |
会社でData Objectsが有効になっていない | ワークスペースでAccountsがプロビジョニングされていることを確認してください。 |
429 |
レート制限を超過した | X-RateLimit-Reset の後に再試行し、リクエストの頻度を減らしてください。 |
500 |
バッチを受け付けられなかった (internal-error) |
Brazeは何も受け付けていないため、リクエストを安全に再試行できます。 |