Sign in
Stream Monitors

Update stream monitor

Update an existing stream monitor. All fields are optional; only provided fields will be updated. Use status field to pause or resume monitoring.

patch/v1/twitter/stream/monitors/{monitor_id}

Path parameters

monitor_idstring required

The unique ID of the stream monitor.

Request body

namestring

Updated name for the stream monitor.

usernamesstring[]

Updated list of Twitter usernames to monitor.

status'active' | 'paused'

Set monitor status. Use "paused" to stop monitoring and "active" to resume.

webhook_urlstring nullable

Updated webhook URL. Set to null to remove webhook delivery.

webhook_secretstring nullable

Updated webhook secret. Set to null to remove.

filter_typesstring[] nullable

Updated tweet type filter. Set to null to deliver all types.

Response

Stream monitor updated successfully.

idstring required

Unique stream monitor identifier.

namestring required

Human-readable name of the monitor.

usernamesstring[] required

List of monitored Twitter usernames.

status'active' | 'paused' | 'suspended' required

Current status of the monitor. Suspended indicates the monitor was auto-paused due to insufficient credits.

status_reasonstring nullable

Reason for the current status, if applicable (e.g., "insufficient_credits").

webhook_urlstring nullable

HTTPS URL receiving webhook deliveries.

webhook_secret_setboolean

Whether a webhook secret is configured. The actual secret is never returned.

filter_typesstring[] nullable

Tweet types being delivered. Null means all types.

credits_per_account_per_daynumber

Credit cost per monitored account per day.

estimated_credits_per_daynumber

Estimated total credit cost per day based on current account count.

pricing_tierstring

Current pricing tier label.

created_atstring date-time required

Timestamp when the monitor was created.

updated_atstring date-time required

Timestamp when the monitor was last updated.

Example response

{
  "name": "Tech Leaders Monitor",
  "usernames": [
    "elonmusk",
    "sama"
  ],
  "pricing_tier": "Standard"
}

Changes

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