v

latestOpenAPI 3.1.02026-08-09127104507.8 KB

Monitors

Update keyword monitor

Update keyword monitor.

patch/api/v1/monitors/keywords/{id}

Path parameters

idstring required

Resource ID returned by the matching create or list endpoint.

Request body

eventTypesEventType[]

Array of event types to subscribe to.

isActiveboolean

Example request

{
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "isActive": true
}

Response

Keyword monitor updated

idstring required

querystring required

eventTypesEventType[] required

Array of event types to subscribe to.

isActiveboolean required

createdAtstring date-time required

nextBillingAtstring date-time required

Next hourly credit charge time for this keyword query monitor.

Example response

{
  "id": "21",
  "query": "xquik OR \"x api\"",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "isActive": true,
  "createdAt": "2025-01-15T12:00:00Z",
  "nextBillingAt": "2025-01-15T12:00:00Z"
}