---
title: "PATCH /api/v1/monitors/{id}"
method: PATCH
path: "/api/v1/monitors/{id}"
tags: ["Monitors"]
---

# PATCH /api/v1/monitors/{id}

`PATCH /api/v1/monitors/{id}`

## Request

- Base URL: `https://xquik.com`
- URL: `https://xquik.com/api/v1/monitors/{id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Updates an account monitor's event types or active state. A monitor turned on again starts from that moment, with no event for a post made while it was off. Read those posts with the timeline & search routes.

## Path parameters

- `id` string, required

## Request body

- object
  - `eventTypes` EventType[]: Array of event types to subscribe to.
  - `isActive` boolean
  - `name` string, nullable: New label for the account monitor. Send null to remove the label.

## Response `200`

Monitor updated

- Monitor: Account monitor that tracks activity for a given X user.
  - `id` string, required
  - `username` string, required
  - `xUserId` string, required
  - `name` string: Customer-set label of the account monitor, when set.
  - `eventTypes` EventType[], required: Array of event types to subscribe to.
  - `isActive` boolean, required
  - `createdAt` string, date-time, required
  - `nextBillingAt` string, date-time, required: Next hourly credit charge time for this account monitor.
  - `pausedReason` 'insufficient_credits' | 'x_account_protected' | 'x_user_not_found': Why Xquik paused this account monitor. `insufficient_credits` means the balance could not pay an hour, so add credits & resume. The other 2 mean X stopped showing the account. Absent when the monitor is active or you paused it yourself.
  - `pausedAt` string, date-time: When Xquik paused this account monitor.

## Other responses

- `400`: Invalid input. A value past its maxLength gets this answer, & the message names the field & its limit.
- `401`: Unauthenticated
- `404`: Not found
- `409`: The monitored X account is still unavailable
- `429`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `500`: Unexpected error.
- `default`: Unexpected error.

## Changes

- **2026-10-20** `45942c75fdc2`: 14 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `400`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - …10 more

[Operation history](https://skmtc.dev/xquik-dev/apis/xquik-api/changes/api/v1/monitors/:id/patch.md)

---

[API](https://skmtc.dev/xquik-dev/apis/xquik-api.md) · [All operations](https://skmtc.dev/xquik-dev/apis/xquik-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xquik-dev/apis/xquik-api/revisions/45942c75fdc2?raw)