PATCH https://xquik.com/api/v1/monitors/{id}
Free. This endpoint does not consume credits.
monitor_id, event_types, is_active, next_billing_at, verify_endpoint,
list_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.How to set Twitter alerts for an existing account monitor
Read the monitor before changing its Twitter alert settings. Save itsid,
username, xUserId, eventTypes, isActive, and nextBillingAt.
Send the complete eventTypes array when coverage changes. The new array
replaces every existing event type. Omit it when only isActive changes.
If the account is gone or private, the API returns
409 monitor_profile_unavailable. Retry once it is back and public.
Finally, compare the returned account, filter, and active state with the
approved request.Which Twitter alert settings can this endpoint change?
Account filters select future events. Your webhook receiver
can notify Slack, update a CRM record, or queue work.
How do Twitter account alert settings work in this Twitter monitoring tool?
Twitter account alert settings choose the captured changes. Authenticate with an API key or bearer token. To receive notifications, subscribe a webhook to the same event types. Webhook notification settings choose the HTTPS receiver. They do not change the Twitter account or event filter. Use keyword alerts for brand mentions, hashtags, products, or campaign phrases. Manage keyword monitoring through Update Keyword Monitor.How do I send Twitter account alerts to Slack or a CRM?
Update the account filter, then compare it with List Webhooks. Subscribe the receiver to every required event type. Run Test Webhook before waiting for account activity. Validate each signature, then acknowledge valid requests before slow work. Process slower Slack or CRM work after acknowledgment. List Events confirms event storage. List Deliveries confirms delivery attempts.How do I reduce high-volume Twitter alert noise?
Select only required events. Select mention and reply events when those interactions matter. Add repost, quote, media, or link events only when your workflow uses those payloads. Use a keyword monitor for words, hashtags, products, or campaigns. Account monitor event types do not express Boolean search rules, languages, sensitivity, or sentiment. Keep webhook subscriptions aligned. Join delivery attempts to stored events withstreamEventId.Update handoff
Use this endpoint to change event scope. You can also pause or resume an account alert without creating another monitor ID.Returned state
Store returned
id, username, xUserId, eventTypes, isActive,
createdAt, and nextBillingAt. They are the current account monitor
configuration.Inventory sync
After the PATCH, refresh List Monitors and
compare
Get Monitor for
the same
id. Do this before updating queues, CRM records, or support
notes.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 future account checks, stored events, future webhook
deliveries, and hourly monitor billing. It applies to this monitor.Resume monitoring
isActive: true resumes checks for matching future account activity. Check
nextBillingAt, then run Test Webhook
before relying on production alerts. Posts made during the pause send no
event. Read them with User Tweets or
Search Tweets.Account identity
PATCH cannot change
username or xUserId. Delete this monitor and create
a new account monitor when the tracked account changes.Downstream join
After the update, keep using
monitorId and username from
List Events. Use them to reconcile stored
events. Use event IDs with Get Event when a
workflow needs the full tweet payload.Delivery audit
Use List Deliveries for each webhook
and join delivery
streamEventId to event IDs. Do not use x_event_id as
the delivery join key.Change one account monitor
Read the current monitor first. Send every approvedeventTypes value. Use
isActive: false for a temporary stop. Check credits before sending true.
Then verify id, username, xUserId, eventTypes, and nextBillingAt.
PATCH changes future monitoring only. It never rewrites stored events or past
deliveries. Create another monitor when the tracked profile changes.Prepare a reversible account monitor change
Record the current ID, username, events, active state, and billing time. Add the approved future values beside them. Send only supported PATCH fields. If verification fails, read the monitor again. Do not send an automatic rollback. Another approved update may already exist.Separate pausing, filtering, and deletion
Pause when the monitor may resume. ReplaceeventTypes to change future scope.
Delete only for permanent removal. Create another monitor for another profile.
This does not change past account events.Verify the first event after resuming
Read the monitor and confirmisActive: true. Then inspect the first matching
event’s type and timestamp. Check deliveries separately. A successful PATCH does
not prove delivery.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 monitor exists with this ID, or it belongs to a different account.409 Profile unavailable
The X account is gone or private. Resume the monitor once it is back & public. You can still pause it or change its event filters.429 Rate limited
Too many requests. Wait for theRetry-After header before retrying.isActive: false pauses future checks, stored events, webhook deliveries, and
hourly monitor billing. It applies to this monitor. isActive: true resumes
future checks with the returned eventTypes.Related.
- List Monitors to refresh inventory.
- Get Monitor to verify this monitor.
- List Events to audit stored events.
- Get Event to inspect one event.
- List Webhooks to compare subscriptions.
- List Deliveries to audit webhook delivery status.
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." } - 409
{ "error": "monitor_profile_unavailable", "message": "X account is gone or private. Resume once it is back & public." } - 429
{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }