---
updatedAt: 2026-05-11T06:52:42.000Z
agentTools:
  projectIndex: https://platform.simpplr.com/llms.txt
---

# Delete alert

This API allows us to delete an Alert using alert id. But you can only delete schedueled alerts.

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "version": "1.0.0",
    "title": "Simpplr User API Documentation",
    "description": ""
  },
  "x-proxy-enabled": true,
  "tags": [
    {
      "name": "Alerts",
      "description": "Everything about Alerts"
    }
  ],
  "servers": [
    {
      "url": "https://{endpoint}/v1",
      "variables": {
        "env": {
          "default": "app"
        },
        "endpoint": {
          "default": "platform.app.simpplr.com"
        }
      }
    }
  ],
  "paths": {
    "/alerts/{alertId}": {
      "delete": {
        "tags": [
          "Alerts"
        ],
        "summary": "Delete alert",
        "description": "This API allows us to delete an Alert using alert id. But you can only delete schedueled alerts.",
        "parameters": [
          {
            "name": "alertId",
            "in": "path",
            "description": "ID of alert to delete",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Delete alert",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeleteAlert"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Alert deleted successfully."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/ValidationError"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ValidationError": {
        "type": "array",
        "items": {
          "properties": {
            "seq_id": {
              "type": "integer",
              "example": 0
            },
            "field_name": {
              "type": "string",
              "example": "sentTo"
            },
            "error_code": {
              "type": "integer",
              "example": "1001"
            },
            "message": {
              "type": "string",
              "example": "should have required property 'sentTo'"
            }
          }
        }
      },
      "DeleteAlert": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of alert. \n delete in this case",
            "enum": [
              "delete"
            ]
          }
        }
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Authorize error",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "example": "Missing/Invalid authentication token"
                }
              }
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden error",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error_code": {
                  "type": "integer",
                  "example": 2001
                },
                "message": {
                  "type": "string",
                  "example": "Something went wrong, please try again"
                }
              }
            }
          }
        }
      },
      "ValidationError": {
        "description": "Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ValidationError"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "apiAuthSecurity": {
        "type": "oauth2",
        "description": "This API uses OAuth 2 with the implicit grant flow.",
        "flows": {
          "implicit": {
            "authorizationUrl": "https://platform.test.simpplr.xyz/v1",
            "scopes": {
              "read": "read data",
              "write": "create/update data",
              "everything": "allow full access"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "apiAuthSecurity": []
    }
  ]
}
```