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).