PendiumDocs

update_visibility_query

Edit a visibility query's text or reach level, or toggle whether it runs in future scans.

Edit the text or reach level of an existing visibility query, or toggle whether it runs in future scans. At least one of query, reachLevel, or isActive must be provided.

Deprecated alias: update_query is still accepted but update_visibility_query is the canonical name.

Authentication: Required

Parameters

ParameterTypeRequiredDescription
syntheticIdintegerYesThe agent ID the query belongs to.
queryIdstringYesThe query ID to update.
querystring (1–500)NoNew query text.
reachLevelenumNocore (direct brand), adjacent (category), aspirational (broader industry), or visionary (thought leadership).
isActivebooleanNoSet false to exclude this query from future scans.

Use list_visibility_topics to find query IDs, or delete_visibility_query to remove one permanently.

On this page