Skip to main content
POST
Delete a notification endpoint
このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
Notification Endpoint を一覧取得で返される apiNotificationId を指定して、登録済みの通知エンドポイントを 1 件削除します。1 回の呼び出しで削除できるのは 1 件です。レスポンスにペイロードはありません——meta.status で結果を確認してください。
削除は元に戻せません。無効化や一時停止の機能はないため、配信をいったん止めて後で再開したい場合は、エンドポイントを削除し、後日あらためて登録してください(その際は再度検証が実行されます)。
削除できるのは、自分のアカウントが本 API を通じて登録したエンドポイントのみです。存在しない、または他のアカウントに属する apiNotificationId を指定した場合は、HTTP 200meta.status 400meta.errorCode VALIDATION_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).