Skip to main content
POST
Delete a notification endpoint
Deletes one registered notification endpoint, identified by the apiNotificationId returned by List notification endpoints. One endpoint per call. The response carries no payload — read meta.status to confirm.
Deletion is permanent. There is no disable or pause; to stop and later resume deliveries, delete the endpoint and register it again, which runs verification again.
You can only delete endpoints your account registered through this API. An apiNotificationId that does not exist, or belongs to another account, fails with HTTP 200, meta.status 400, meta.errorCode VALIDATION_FAILED, and:

Idempotency

The x-returnhelper-idempotency-key header is optional. A call without it runs normally, with no protection against duplicates. See Idempotency.

Authorizations

x-rr-apikey
string
header
required

Your API key

x-rr-apitoken
string
header
required

Your API token — keep this private

Body

application/json
apiNotificationId
integer<int64>
required

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

Example:

1234

Response

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