Update alert with the Mention API

Updates an alert, usually to refine its query, and returns it. Only the fields sent change. A query sent replaces the current one and needs its type.

Identifier
mention_update_alert

The request

POST https://connect.reportei.com/api/tools/mention_update_alert/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "account_id": "<account_id>",
    "alert_id": "<alert_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
account_idstringYesId of the account, from Get account.
alert_idstringYesId of the alert, from List alerts.
namestringNoNew name of the alert.
queryobjectNoWhat the alert tracks. A basic query takes included_keywords, required_keywords, excluded_keywords and monitored_website, with at least one keyword in included_keywords or required_keywords. An advanced query takes query_string instead.
languagesarrayNoCodes of up to 5 languages to track, such as en or pt, from the alert_languages of Get app data. Replaces the current list.
countriesarrayNoCodes of up to 5 countries to track, such as US or BR, from the alert_countries of Get app data. XX keeps the mentions without a country. Replaces the current list.
sourcesarrayNoCodes of the sources to track, such as web, news, blogs, forums, videos, twitter or facebook, from the alert_sources of Get app data. Replaces the current list.
blocked_sitesarrayNoURLs whose mentions are ignored. Replaces the current list.
noise_detectionbooleanNotrue skips new mentions similar to the ones put in spam or trash.
reviews_pagesarrayNoURLs of review pages on Tripadvisor, Yelp or Booking to monitor. Replaces the current list.

Supported connections

Your customer connects their Mention account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/mention_update_alert. It becomes your agent's tool definition with no conversion.

Other Mention tools

See all 10 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.