Monitors

Update keyword monitor

Updates mutable settings for an existing keyword monitor.

patch/monitors/keywords/{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
namestring nullable

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

Example request

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

Response

Keyword monitor updated

idstring required
querystring required
namestring

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

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 keyword query monitor.

Example response

{
  "id": "21",
  "query": "xquik OR \"x api\"",
  "name": "Launch mentions",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "isActive": true,
  "createdAt": "2025-01-15T12:00:00Z",
  "nextBillingAt": "2025-01-15T12:00:00Z"
}

Changes

Changed in 10 of the 32 revisions of this API.1602

    • ●

      added the new draw_too_large enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new draw_too_large enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new draw_too_large enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new draw_too_large enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new draw_too_large enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new draw_too_large enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new draw_too_large enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new draw_too_large enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new retweeters_incomplete enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new retweeters_incomplete enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new retweeters_incomplete enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new retweeters_incomplete enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new retweeters_incomplete enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new retweeters_incomplete enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new retweeters_incomplete enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new retweeters_incomplete enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ●

      added the new bookmark_folders_unavailable enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new bookmark_folders_unavailable enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new bookmark_folders_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new bookmark_folders_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new bookmark_folders_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new bookmark_folders_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new bookmark_folders_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new bookmark_folders_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new search_unavailable enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new search_unavailable enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new search_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new search_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new search_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new search_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new search_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new search_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new idempotency_in_progress enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new idempotency_in_progress enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new idempotency_in_progress enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new idempotency_in_progress enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new idempotency_in_progress enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new idempotency_in_progress enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new idempotency_in_progress enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new idempotency_in_progress enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ●

      added the new likes_unavailable enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new likes_unavailable enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new likes_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new likes_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new likes_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new likes_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new likes_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new likes_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new pagination_stalled enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new pagination_stalled enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new pagination_stalled enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new pagination_stalled enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new pagination_stalled enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new pagination_stalled enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new pagination_stalled enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new pagination_stalled enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new x_reply_not_allowed enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new x_reply_not_allowed enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new x_reply_not_allowed enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new x_reply_not_allowed enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new x_reply_not_allowed enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new x_reply_not_allowed enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new x_reply_not_allowed enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new x_reply_not_allowed enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new closed enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new closed enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new closed enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new closed enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new closed enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new closed enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new closed enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new closed enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new expired enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new expired enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new expired enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new expired enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new expired enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new expired enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new expired enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new expired enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the // response property for the response status

      response-property-enum-value-added