update_saved_search

Update a saved search's name (and/or other fields) by id.

update_saved_search

Update a saved search's name (and/or other fields) by id.

Safety class: C · API type: portal · Min version:

📘

Confinement

Class C: only update saved searches you created. Non-prod only.

Signatures

def update_saved_search(sdk, saved_search_id, name=None):
    """Patch a saved search (e.g. rename) by id; return the updated dict or None."""
    return sdk.update_saved_search(saved_search_id, name=name)
export async function updateSavedSearch(sdk, savedSearchId, name = null) {
    // Positional: (id, name, featured, bookmarked, public, sequence, type, ...). Trailing args default to undefined.
    return await sdk.updateSavedSearch(savedSearchId, name);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
saved_search_idsavedSearchIdstryese.g. <saved-search-uuid>
namenamestr | Nonenoe.g. renamed search

Returns

dict | None — updated saved search; None on failure.

Errors

  • 401 unauthenticated
  • 404 not found

See also: Python ↔ JS naming map · Return shapes.