刪除外部ID
帖子
/用戶/ external_ids /刪除
使用該端點刪除舊用戶的棄用外部id。
你可以發送50每個請求外部id。您將需要創建一個新的API密匙這個端點的權限。
警告:
這個端點完全消除了棄用ID和無法回複。使用該端點將棄用external_ids
仍與用戶相關的係統中可以永久地阻止你找到這些用戶的數據。
速率限製
我們每分鍾1000個請求的速率限製適用於這個端點,作為記錄API率限製。
請求體
1 2
內容類型:application / json授權:無記名YOUR-REST-API-KEY
1 2 3
{“external_ids”:(需要,數組的外部標識符來刪除)}
請求參數
參數 | 要求 | 數據類型 | 描述 |
---|---|---|---|
external_ids |
要求 | 字符串數組 | 外部用戶刪除標識符。 |
請求示例
1 2 3 4 5 6 7 8 9
curl——位置請求發布的https://rest.iad - 01. braze.com/users/external_ids/remove \——頭的application / json內容類型:\——頭的授權:無記名YOUR-REST-API-KEY \ data-raw”{“external_ids”(“existing_deprecated_external_id_string”:……]}’
重要的是:
隻有棄用IDs可以刪除;試圖刪除一個主要外部ID將導致一個錯誤。
響應
響應將確認所有成功刪除,以及成功刪除相關的錯誤。中的錯誤消息removal_errors
字段將參考原始請求的數組中的索引。
1 2 3 4 5
{“消息”:(字符串)狀態消息,“removed_ids”:成功的刪除操作(字符串數組),“removal_errors”:(數組的數組)<小錯誤消息>}
的消息
字段將返回成功
對於任何有效的請求。更具體的錯誤捕獲的removal_errors
數組中。的消息
字段返回一個錯誤的例子:
- 無效的API密匙
- 空
external_ids
數組 external_ids
數組有超過50項- 速率限製打擊(超過1000個請求/分鍾)