Skip to main content
Cancel alert by id
curl --request POST \
  --url https://api.campflare.com/v2/alert/:id/cancel
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "active",
  "campground_ids": [
    "<string>"
  ],
  "parameters": {
    "date_ranges": [
      {
        "starting_date": "2023-12-25",
        "nights": 123
      }
    ],
    "status": [
      "available"
    ],
    "campsite_kinds": [
      "standard"
    ],
    "min_rv_length": 123,
    "min_trailer_length": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "notifications": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sent_at": "2023-11-07T05:31:56Z",
      "campground_id": "<string>",
      "campsite_id": "<string>",
      "webhook_status": "delivered",
      "date_range": {
        "starting_date": "2023-12-25",
        "nights": 123
      },
      "webhook_http_response_code": "<string>"
    }
  ],
  "canceled_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}
This endpoint stops an Alert immediately. The alert will still be accessible via the get endpoint, however it will no longer send any notifications. An Alert can not be resumed once canceled.

Response

Alert response

​
id
string<uuid>
required

Unique identifier for the alert

​
status
enum<string>
required

Status of the alert

Available options:
active,
canceled,
expired
​
campground_ids
string[]
required
​
parameters
object
required
​
created_at
string<date-time>
required

Timestamp of the alert creation

​
notifications
object[]
required
​
canceled_at
string<date-time>

Timestamp of the last update (when/if canceled)

​
metadata
object

The additional metadata associated with the alert when created