Update Saved Search
Update_Saved_Search updates an existing GovTribe saved search and returns the updated saved-search resource as JSON text.
Input Contract
Update_Saved_Search uses model binding plus field validation. saved_search_id is required and must resolve to an existing saved search visible to the caller, and update authorization requires the caller to be allowed to update that saved search. The editable fields are optional (name, frequency), which means callers can send one field or both in a single update call.
saved_search_id: GovTribe ID of the saved search to update.type:stringrequired:yesdefault:n/a
name: Updated saved-search display name.type:stringrequired:nodefault:omit to keep current nameshape:min length 1, max length 100
frequency: Updated notification cadence.type:string enumrequired:nodefault:omit to keep current frequencyoptions:Daily,Weekly,Instant,Never
Output Contract
Top-level keys:
govtribe_idgovtribe_typegovtribe_urlnamefrequencyqfilterssortsview_results_urlsearches_govtribe_typesearch_persistence_idlast_sentcreated_atupdated_atownercreator
Row keys:
n/a
Relationship retrieval map:
creatorresource_type:usertool:Search_Usersfilter:user_idsnested_keys:govtribe_id,govtribe_type,name,email
ownerresource_type:usertool:Search_Usersfilter:user_idsnested_keys:govtribe_id,govtribe_type,name,email
Usage Patterns
Pattern A: Rename a saved search while keeping frequency unchanged. Tool: Update_Saved_Search
Last updated
Was this helpful?
