Monitoring

Update Monitor

Partial update of an existing monitor. Send status to pause or resume it, webhook_ids to change which webhooks receive its events, or both in the same call (applied atomically). Resuming a paused monitor re-runs the same capacity and per-account cap checks as creating a new one, since it adds load back to monitoring capacity. Cost: Free per call.

post/monitor/{id}

Request

  • Base URL: https://api.twitterapis.com/twitter
  • URL: https://api.twitterapis.com/twitter/monitor/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The id segment of the path, as returned by the endpoint that created the resource.

Request body

statusstring

"active" to resume, "paused" to pause. Omit to leave status unchanged.

webhook_idsstring[]

Array of webhook ids to restrict delivery to. Send an empty array to clear the restriction back to "deliver to every active webhook". Omit the field entirely to leave it unchanged.

domain_filterstring

A bare hostname or full URL to restrict delivery to. Send null or an empty string to clear an existing filter (deliver every new post again). Omit the field entirely to leave it unchanged. Same normalization and hostname-shape validation as Create Monitor.

include_repliesboolean

true to deliver the account's replies as well as its own posts, false to hold replies back. Omit the field entirely to leave it unchanged. Same boolean-only validation as Create Monitor: a non-boolean is a 400 rather than a coercion.

Example request

{
  "status": "paused",
  "webhook_ids": [],
  "domain_filter": "example.com"
}

Response

Pause, resume, or change which webhooks a monitor delivers to.

idstring

The monitor's id.

subjectstring

The monitor's query expression, e.g. from:elonmusk.

kindstring

Monitor type.

statusstring

"active" or "paused" after the update.

degradedboolean

Whether monitoring is currently serving this monitor slower than the published interval.

events_possibly_missedinteger

Running count of possibly-missed events, never reset by an update.

webhook_idsstring[] nullable

The current restriction set, or null for the default (deliver to all).

domain_filterstring nullable

The current normalized domain filter after this update, or null if none is set (deliver every new post).

updated_atstring

ISO 8601 timestamp of this update.

Changes

No recorded changes to this operation across all 1 revision of this API.