Monitors

Update monitor

Updates mutable settings for an existing account monitor.

patch/api/v1/monitors/{id}

Path parameters

idstring required

Resource ID returned by the matching create or list endpoint.

Request body

eventTypesEventType[]

Array of event types to subscribe to.

isActiveboolean

Example request

{
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "isActive": true
}

Response

Monitor updated

idstring required

usernamestring required

xUserIdstring required

eventTypesEventType[] required

Array of event types to subscribe to.

isActiveboolean required

createdAtstring date-time required

nextBillingAtstring date-time required

Next hourly credit charge time for this account monitor.

pausedReason'x_user_not_found'

Why Xquik automatically paused this monitor.

pausedAtstring date-time

When Xquik automatically paused this monitor.

Example response

{
  "id": "42",
  "username": "elonmusk",
  "xUserId": "9876543210",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "isActive": true,
  "createdAt": "2025-01-15T12:00:00Z",
  "nextBillingAt": "2025-01-15T12:00:00Z",
  "pausedReason": "x_user_not_found",
  "pausedAt": "2025-01-15T12:00:00Z"
}

Changes

Changed in 2 of the 19 revisions of this API.144

Aug 12, 20265d4938bb7de3108See the full diff
- ●
  added the new closed enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new closed enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new expired enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new expired enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
Aug 12, 20264da209b29df836See the full diff
- ●
  added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added

Full history