OverviewPlatformsAPI Reference
Alerts

Update an alert

Changes an alert. filter and channelIds replace the old values. Queued digests are cancelled, as are queued sends to a removed channel or from a disabled alert.

PATCH
/v1/alerts/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Path Parameters

id*string

The alert's id (feed_...).

Length1 <= length

Request Body

application/json

Fields you leave out stay as they are.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/alerts/feed_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "enabled": true,  "mode": "instant",  "filter": {    "keywordIds": [      "string"    ],    "groupIds": [      "string"    ],    "platforms": [      "bluesky"    ],    "minRelevance": 0,    "minConfidence": 0,    "sentiments": [      "positive"    ],    "intents": [      "string"    ],    "excludeAuthors": [      "string"    ],    "minFollowers": 0,    "tags": [      "string"    ],    "linkHosts": [      "string"    ],    "languages": [      "string"    ],    "automated": true,    "ratings": [      1    ],    "notRatings": [      1    ],    "minLikes": 0,    "minReposts": 0,    "minReplies": 0,    "minQuotes": 0,    "minViews": 0,    "minBookmarks": 0,    "anyOf": [      {        "q": "string",        "keywordIds": [          "string"        ],        "notKeywordIds": [          "string"        ],        "keywordKinds": [          "brand"        ],        "groupIds": [          "string"        ],        "notGroupIds": [          "string"        ],        "platforms": [          "bluesky"        ],        "notPlatforms": [          "bluesky"        ],        "status": "open",        "relevant": true,        "minRelevance": 0,        "minConfidence": 0,        "sentiments": [          "positive"        ],        "notSentiments": [          "positive"        ],        "intents": [          "string"        ],        "notIntents": [          "string"        ],        "automated": true,        "languages": [          "string"        ],        "notLanguages": [          "string"        ],        "tags": [          "string"        ],        "notTags": [          "string"        ],        "linkHosts": [          "string"        ],        "notLinkHosts": [          "string"        ],        "minFollowers": 0,        "maxFollowers": 0,        "isReply": true,        "excludeAuthors": [          "string"        ],        "ratings": [          1        ],        "notRatings": [          1        ],        "minLikes": 0,        "minReposts": 0,        "minReplies": 0,        "minQuotes": 0,        "minViews": 0,        "minBookmarks": 0      }    ]  },  "schedule": {    "hour": 0,    "minute": 0,    "timezone": "string",    "skipEmpty": true,    "weekday": 0  },  "event": "string",  "channels": [    {      "id": "string",      "kind": "slack",      "label": "string"    }  ],  "stats": {    "sentLast7d": 0,    "lastSentAt": "string",    "nextRunAt": "string"  },  "createdAt": "string"}
Was this page helpful?

Unmute authors

Takes authors off the muted list, keeping the rest of the filter. Each entry can be the stored value or any link to the person's profile or posts. Retrying is safe, because authors who aren't muted are skipped.

Update a channel

Changes a channel's label and account events, and a webhook's URL and headers. `headers` and `events` replace the old values.