Skip to main content
PATCH
/
v1
/
alerts
/
{id}
cURL
curl -X PATCH \
  -H "X-API-Key: $PARTICLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.particle.pro/v1/alerts/{id}"
{
  "created_at": "2023-11-07T05:31:56Z",
  "delivery_cadence": "<string>",
  "entities": [
    {
      "entity_id": "<string>",
      "image_url": "<string>",
      "name": "<string>"
    }
  ],
  "id": "<string>",
  "is_active": true,
  "notifications": [
    {
      "type": "EMAIL",
      "email": "jsmith@example.com",
      "id": "<string>"
    }
  ],
  "project_id": "<string>",
  "title": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "<string>",
    "name": "<string>"
  },
  "description": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Pass your API key in the X-API-Key header (recommended).

Path Parameters

​
id
string
required

Alert ID

Body

application/json
​
delivery_cadence
enum<string>
Available options:
REALTIME,
DAILY,
WEEKLY
​
description
string
Maximum string length: 2000
​
entities
object[]
Required array length: 1 - 100 elements
​
is_active
boolean

Toggle whether the alert produces matches. False pauses; true resumes.

​
notifications
object[]
Required array length: 1 - 20 elements
​
title
string
Required string length: 1 - 200

Response

OK

​
created_at
string<date-time>
required
​
delivery_cadence
string
required

How often matches are delivered to all configured channels: REALTIME (per-match), DAILY, or WEEKLY. v1 only emits REALTIME; DAILY/WEEKLY are accepted but treated as REALTIME until the digest worker ships.

​
entities
object[] | null
required
​
id
string
required
​
is_active
boolean
required

Whether the alert produces matches. Disabled alerts retain history but accumulate no new matches until re-enabled.

​
kind
enum<string>
required

What signal the alert watches for. ENTITY_MENTION fires whenever a watched entity is mentioned in a podcast episode. PODCAST_SPEAKER fires only when a watched entity is themself an identified speaker on the episode, in one of the canonical appearance buckets — GUEST, PANELIST, CORRESPONDENT, or AUDIENCE (this last bucket absorbs callers, listeners, and other audience-side roles after server-side canonicalization). HOST is intentionally excluded — hosting the show isn't an appearance. Kind is fixed at creation.

Available options:
ENTITY_MENTION,
PODCAST_SPEAKER
​
notifications
object[] | null
required
​
project_id
string
required
​
title
string
required
​
updated_at
string<date-time>
required
​
created_by
object

User who created the alert. Null when the alert was created via an API key.

​
description
string