Monitors

Update post monitor

Updates a post monitor's label, event types or active state. Turning a paused monitor on reads the post first, & answers 409 while X hides it.

patch/api/v1/monitors/posts/{id}

Request

  • Base URL
    https://xquik.com
  • URL
    https://xquik.com/api/v1/monitors/posts/{id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring required

Resource ID returned by the matching create or list endpoint.

Request body

eventTypesPostEventType[]

Post event types to send. Without it, a monitor sends new replies, new quotes, like & retweet changes, edits & deletion.

isActiveboolean
namestring nullable

New label for the post monitor. Send null to remove it.

Example request

{
  "eventTypes": [
    "post.reply.new",
    "post.quote.new",
    "post.likes.changed"
  ],
  "isActive": true,
  "name": "Launch post"
}

Response

Post monitor updated

idstring required
namestring

Customer-set label of the post monitor, when set.

postIdstring required

ID of the post you gave.

postUrlstring uri required
authorIdstring required

Permanent X user ID of the post's author.

authorUsernamestring required
authorNamestring required
authorAvatarUrlstring uri

The author's profile picture. Omitted when X shows none.

authorVerified'blue' | 'business' | 'government'

The author's verified badge on X. Omitted when the author has none.

textstring required

Text of the newest version Xquik read.

postedAtstring date-time required
eventTypesPostEventType[] required

Post event types to send. Without it, a monitor sends new replies, new quotes, like & retweet changes, edits & deletion.

isActiveboolean required
createdAtstring date-time required
nextBillingAtstring date-time required

Next hourly credit charge time for this post monitor.

pausedReason'insufficient_credits' | 'x_post_deleted' | 'x_post_protected' | 'x_post_unavailable'

Why Xquik paused this post monitor. insufficient_credits means the balance could not pay an hour, so add credits & resume. The other 3 mean X stopped showing the post. Absent when the monitor is active or you paused it yourself.

pausedAtstring date-time

When Xquik paused this post monitor.

Example response

{
  "id": "31",
  "name": "Launch post",
  "postId": "2102882545427714266",
  "postUrl": "https://x.com/NASA/status/2102882545427714266",
  "authorId": "11348282",
  "authorUsername": "NASA",
  "authorName": "NASA",
  "authorAvatarUrl": "https://pbs.twimg.com/profile_images/1321163587679784960/0ZxKlEKB_normal.jpg",
  "authorVerified": "government",
  "media": [
    {
      "kind": "photo",
      "url": "https://pbs.twimg.com/media/GxPhoto.jpg"
    }
  ],
  "text": "Today, Croatia became the 74th nation that has committed to a peaceful and prosperous exploration of space.",
  "postedAt": "2026-09-23T22:07:23.000Z",
  "eventTypes": [
    "post.reply.new",
    "post.quote.new",
    "post.likes.changed"
  ],
  "isActive": true,
  "createdAt": "2025-01-15T12:00:00Z",
  "nextBillingAt": "2026-10-22T12:00:00Z",
  "baseline": {
    "at": "2026-10-22T11:00:00Z",
    "views": 541100,
    "likes": 1885,
    "retweets": 112,
    "replies": 85,
    "quotes": 87,
    "bookmarks": 470
  },
  "pausedReason": "x_post_deleted",
  "pausedAt": "2026-10-22T12:00:00Z",
  "metrics": {
    "views": {
      "current": 1885,
      "gain": 12
    },
    "likes": {
      "current": 1885,
      "gain": 12
    },
    "retweets": {
      "current": 1885,
      "gain": 12
    },
    "replies": {
      "current": 1885,
      "gain": 12
    },
    "quotes": {
      "current": 1885,
      "gain": 12
    },
    "bookmarks": {
      "current": 1885,
      "gain": 12
    }
  }
}

Changes