Skip to main content
POST
Delete a notification endpoint
此頁面由 AI 自動翻譯。API 技術規格以英文呈現為標準。如有任何疑問,請參閱英文版本
列出 Notification Endpoints 回傳的 apiNotificationId 刪除一個已註冊的通知端點。每次呼叫只能刪除一個端點。回應不含 Payload——請讀取 meta.status 以確認結果。
刪除為永久性操作。系統不提供停用或暫停功能;若要先停止、日後再恢復接收通知,請刪除該端點並於日後重新註冊,屆時會再次執行驗證流程。
您只能刪除自己的帳戶透過本 API 註冊的端點。若 apiNotificationId 不存在或屬於其他帳戶,會回傳 HTTP 200meta.status400meta.errorCodeVALIDATION_FAILED

等冪性

x-returnhelper-idempotency-key 標頭為選填。未帶此標頭的呼叫會正常執行,但不具備防重複的保護。請參閱等冪性

授權

x-rr-apikey
string
header
必填

Your API key

x-rr-apitoken
string
header
必填

Your API token — keep this private

主體

application/json
apiNotificationId
integer<int64>
必填

Identifier of the notification endpoint to delete, as returned by /api/Notification/GetAll.

範例:

1234

回應

Success — returns the standard response envelope with no additional payload fields. Inspect meta.status to confirm the deletion succeeded.

Universal response envelope. Successful responses include the business payload as additional top-level fields alongside correlationId and meta. Failed responses (auth errors, validation errors) only populate correlationId and meta, with meta.errorCode and meta.error describing the failure.

correlationId
string | null

Unique correlation ID for tracing the request through Return Helper systems.

meta
object

Application-level metadata for every API response. Inspect status and errorCode to detect soft-error responses (validation failures arrive as HTTP 200 with meta.status: 400).