---
updatedAt: 2025-06-04T21:28:21.000Z
agentTools:
  projectIndex: https://developer.simpplr.com/llms.txt
---

# Expire an Alert

Use this API to expire an active Alert.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "simpplr-api-gateway",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.ec.simpplr.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/alerts/{alert-id}?expire=true": {
      "put": {
        "summary": "Expire an Alert",
        "description": "Use this API to expire an active Alert.",
        "operationId": "expire-an-alert",
        "parameters": [
          {
            "name": "alert-id",
            "in": "path",
            "schema": {
              "type": "string",
              "default": "a025e000008VvrlAAC"
            },
            "required": true
          },
          {
            "name": "x-user-email",
            "in": "header",
            "description": "User's email to login into Salesforce",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"success\",\n    \"result\": {\n        \"status\": \"expired\",\n        \"seenCount\": 0,\n        \"recipientCount\": 5,\n        \"recipient\": \"everyone\",\n        \"modifiedAt\": \"2021-09-14T17:37:07.000+0530\",\n        \"message\": \"Updated alert message!\",\n        \"membersType\": \"site_members\",\n        \"isDismissible\": true,\n        \"displayTo\": \"2021-12-10T11:03:04.000+0530\",\n        \"displayFrom\": \"2021-09-14T17:27:48.000+0530\",\n        \"createdAt\": \"2021-09-14T11:51:22.000+0530\",\n        \"canDelete\": false,\n        \"authoredBy\": {\n            \"videoCallProvider\": \"zoom\",\n            \"userId\": \"0055e000006GGxxxxx\",\n            \"url\": \"https://xxxxxxx.visualforce.com/apex/app?u=/people/a115e000002FFncAAG\",\n            \"peopleId\": \"a115e000002FFncAAG\",\n            \"name\": \"Arun Cherian\"\n        },\n        \"alertId\": \"a025e000008Vxxxxx\"\n    },\n    \"responseTimeStamp\": \"1631621234526\",\n    \"message\": \"\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "result": {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "expired"
                        },
                        "seenCount": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "recipientCount": {
                          "type": "integer",
                          "example": 5,
                          "default": 0
                        },
                        "recipient": {
                          "type": "string",
                          "example": "everyone"
                        },
                        "modifiedAt": {
                          "type": "string",
                          "example": "2021-09-14T17:37:07.000+0530"
                        },
                        "message": {
                          "type": "string",
                          "example": "Updated alert message!"
                        },
                        "membersType": {
                          "type": "string",
                          "example": "site_members"
                        },
                        "isDismissible": {
                          "type": "boolean",
                          "example": true,
                          "default": true
                        },
                        "displayTo": {
                          "type": "string",
                          "example": "2021-12-10T11:03:04.000+0530"
                        },
                        "displayFrom": {
                          "type": "string",
                          "example": "2021-09-14T17:27:48.000+0530"
                        },
                        "createdAt": {
                          "type": "string",
                          "example": "2021-09-14T11:51:22.000+0530"
                        },
                        "canDelete": {
                          "type": "boolean",
                          "example": false,
                          "default": true
                        },
                        "authoredBy": {
                          "type": "object",
                          "properties": {
                            "videoCallProvider": {
                              "type": "string",
                              "example": "zoom"
                            },
                            "userId": {
                              "type": "string",
                              "example": "0055e000006GGxxxxx"
                            },
                            "url": {
                              "type": "string",
                              "example": "https://xxxxxxx.visualforce.com/apex/app?u=/people/a115e000002FFncAAG"
                            },
                            "peopleId": {
                              "type": "string",
                              "example": "a115e000002FFncAAG"
                            },
                            "name": {
                              "type": "string",
                              "example": "Arun Cherian"
                            }
                          }
                        },
                        "alertId": {
                          "type": "string",
                          "example": "a025e000008Vxxxxx"
                        }
                      }
                    },
                    "responseTimeStamp": {
                      "type": "string",
                      "example": "1631621234526"
                    },
                    "message": {
                      "type": "string",
                      "example": ""
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"statusCode\": 400,\n    \"status\": \"error\",\n    \"message\": \"\",\n    \"data\": {}\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "statusCode": {
                      "type": "integer",
                      "example": 400,
                      "default": 0
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "message": {
                      "type": "string",
                      "example": ""
                    },
                    "data": {
                      "type": "object",
                      "properties": {}
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"error\",\n    \"message\": \"SESSION_TIMEOUT\",\n    \"i18nmessage\": \"SESSION_TIMEOUT\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "message": {
                      "type": "string",
                      "example": "SESSION_TIMEOUT"
                    },
                    "i18nmessage": {
                      "type": "string",
                      "example": "SESSION_TIMEOUT"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```