Skip to main content
PATCH https://xquik.com/api/v1/monitors/keywords/{id}

When to update a keyword monitor

Use this route to change one keyword monitor’s event types or active state. Use get to read one monitor. Use list to see every keyword monitor on the account.
Free. This endpoint does not consume credits.
The cURL, Node.js, Python, and Go examples convert the updated keyword monitor. The result is one state row. Store keyword_monitor_id, query, event_types, is_active, next_billing_at, verify_endpoint, delete_endpoint, events_endpoint, event_detail_endpoint_pattern, webhooks_endpoint, and deliveries_endpoint_pattern. Do this before resuming alerts or webhook checks.

Path parameters

Headers

Body

At least 1 field is required.
You cannot change the monitored query. Delete this monitor and create another one to track a different query.

Update handoff

Use this endpoint when a keyword alert changes scope or needs a temporary pause. Also use it when the alert must resume without creating a new monitor ID.

Returned state

Store returned id, query, eventTypes, isActive, createdAt, and nextBillingAt. They are the current keyword monitor configuration.

Event filter

eventTypes replaces the current filter. Keep List Webhooks subscriptions aligned with the monitor event types you expect to deliver.

Pause monitoring

isActive: false pauses keyword polling, stored events, future webhook deliveries, and hourly monitor billing. It applies to this monitor.

Resume monitoring

isActive: true resumes polling for matching future tweets. Check nextBillingAt, then run Test Webhook before relying on production alerts. Posts made during the pause send no event. Read them with Search Tweets.

Query change

PATCH cannot change query. Delete this monitor and create a new keyword monitor. Do this when the X (Twitter) search query changes.

Downstream join

After the update, keep using keywordMonitorId and query from List Events. Use them to reconcile stored events and signed webhook payloads. Use Get Event for one event’s full payload.

Delivery audit

Use List Deliveries when you must retain webhook delivery evidence. Join delivery streamEventId to event IDs. Do not use x_event_id as the delivery join key.

Delete path

Use Delete Keyword Monitor only when the query should stop permanently. Export event and delivery evidence first when support or audit workflows need history.

Response

200 OK

400 Invalid input

{ "error": "invalid_input", "message": "Empty body, invalid event types, or invalid isActive type" } Empty body, invalid eventTypes values, or invalid isActive type. { "error": "invalid_id", "message": "Invalid ID format." } The provided monitor ID is not a valid format.

401 Unauthenticated

{ "error": "unauthenticated", "message": "Missing or invalid API key" } Missing or invalid API key.

404 Not found

{ "error": "not_found", "message": "Monitor not found" } No keyword monitor exists with this ID, or it belongs to a different account.

429 Rate limited

Too many requests. Wait for the Retry-After header before retrying.

Response examples

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 401 { "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." }
  • 403 { "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }
  • 404 { "error": "not_found", "message": "Resource not found." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }