Delete Notification API
The Delete Notification API removes an existing notification subscription by ID. It uses the DELETE method on /v1/notifications/{id}, requires the x-access-key header, and returns a JSON response containing success and message fields.
Delete Notification API — operation summary with exact method and path
Use this operation when a notification subscription should no longer be active and you have its identifier. The exact contract is DELETE /v1/notifications/{id}. Replace only the origin with {{API_BASE_URL}} in examples, keeping the method and path unchanged. Before calling, confirm the identifier you intend to remove, because the operation targets a single subscription identified in the path.
Authorization
Authorization uses the accessKey supplied in the x-access-key header. Send the token value in that header on the DELETE request. The source contract specifies the header name and location; it does not specify additional behaviour for missing or invalid values, so check the returned status and message for the actual outcome of a call.
Path Parameters
The path contains one required parameter, id, typed as a string and described as the Notification subscription ID. Substitute the actual identifier into /v1/notifications/{id}. No request body is specified in the source contract, so the identifier and the authorization header are the inputs to verify before sending the request.
Request example
The worked example titled Delete a notification subscription with cURL shows the exact DELETE method, the unchanged path, and the x-access-key header. Replace the placeholder token and the id segment with real values from your own records, then inspect the HTTP status and JSON body to confirm the outcome.
Response Body
The response body is JSON for every listed status. Parse success as a boolean and message as a string, and use the status code together with those fields to decide what happened. The source supplies the same response shape for 200, 400, and 404, so do not infer additional fields or distinct error meanings that are not present in the contract.
200 application/json
A 200 application/json response is the listed successful status for this operation. Read the message field for the returned text and check success as a boolean. Keep the raw status and body in logs so a later retry decision is based on the actual response rather than an assumption.
400 application/json
A 400 application/json response uses the same JSON shape with success and message. Record the status and message, and review the request inputs before trying again. The source does not specify a detailed cause for this status, so avoid inventing one beyond the returned fields.
404 application/json
A 404 application/json response also uses the same JSON shape with success and message. Record the status and message, and verify the Notification subscription ID before deciding whether another attempt is appropriate. The source does not specify additional fields or a detailed cause for this status.
| Field | Location | Type | Required | Description |
|---|---|---|---|---|
| id | Path | string | Yes | Notification subscription ID |
Exact source contract: one required string path parameter; no request body specified.
| Status | Content type | success | message |
|---|---|---|---|
| 200 | application/json | boolean, required | string, required |
| 400 | application/json | boolean, required | string, required |
| 404 | application/json | boolean, required | string, required |
All listed statuses share the supplied response shape; distinct error meanings are not specified in the source.
Frequently asked questions
What do I need to delete a notification subscription?
Send a DELETE request to /v1/notifications/{id} with the x-access-key header and the Notification subscription ID in the path. The response is JSON with a required boolean success field and a required string message field, returned with status 200, 400, or 404.
Is a request body required to delete a notification subscription?
The source contract specifies one required string path parameter, id, described as the Notification subscription ID. No request body is specified for this operation.
How should I interpret the response from the Delete Notification API?
Check the status code and parse the JSON body. Every listed status uses the same shape: success as a boolean and message as a string. Do not assume a distinct error meaning beyond the status and message returned.
curl -X DELETE "{{API_BASE_URL}}/v1/notifications/{id}" \
-H "x-access-key: <token>"| Scope | Field | Type | Type reference | Required | Description |
|---|---|---|---|---|---|
| id#1 | id | string | __0 | Yes | Notification subscription ID |
| response#2 | response | object | __0 | ||
| response#2 | response.success | boolean | __1 | Yes | |
| response#2 | response.message | string | __2 | Yes |