Skip to main content
PATCH
Twitter post monitor updates & engagement alerts
Change a post monitor’s label, event types or active state. The tracked post stays the same, so the monitor ID & its history stay usable.
Free. This endpoint does not consume credits. Active monitors bill 30 credits per hour.

Pause & resume a post monitor

Send isActive: false to stop reads, events & hourly billing. The monitor & its history stay. Send isActive: true to resume. Xquik reads the post first. While X hides the post, the route answers 409 & changes nothing. The monitor stays paused & costs nothing. A resumed monitor reports nothing from its pause. Its first read sets the new starting point. To track a different post, create a new monitor. Then delete or pause the old one.

Path parameters

string
required
The post monitor ID.

Headers

string
required
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.
string
required
Must be application/json.

Body

Send at least 1 field.
string[]
Post event types to send, 1 to 10. Replaces the current list. Valid types are post.reply.new, post.quote.new, post.likes.changed, post.retweets.changed, post.replies.changed, post.quotes.changed, post.bookmarks.changed, post.views.changed, post.edited & post.deleted.
string | null
New label, 1 to 80 characters. Send null to remove it.
boolean
false pauses the monitor. true resumes it once X shows the post.

Response

200 OK

Returns the updated monitor, shaped like the Get Post Monitor response.
string
Unique post monitor ID.
string[]
Post event types this monitor sends.
boolean
Whether the monitor is active.
string
Next hourly credit charge time.
object
The 6 metrics, each with current & gain since tracking began.

400 Invalid input

No field to change, or a field is invalid. The message says what to fix.

401 Unauthenticated

Missing or invalid API key.

404 Not found

No post monitor has this ID on your account.

409 Post unavailable

X still hides the post, so the monitor stays paused. reason is deleted, protected or author_suspended when X names it.

429 Rate limited

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

502 X unavailable

X failed the read while resuming. Retry after a short wait.

503 Busy

Xquik is busy right now. Wait for Retry-After, then retry.