Skip to main content
PATCH https://xquik.com/api/v1/monitors/posts/{id} 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

Headers

Body

Send at least 1 field.

Response

200 OK

Returns the updated monitor, shaped like the Get Post Monitor response.

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, author_deactivated, author_suspended or unavailable 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.

Response examples

200 example

  • 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": "post_unavailable", "message": "The author deleted this post. Delete this monitor." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }
  • 502 { "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }
  • 503 { "error": "x_api_unavailable", "message": "Xquik is busy right now. Retry shortly." }