Skip to navigation
API ReferenceSearches

UpdateSearch

UpdateSearch sets the name, the star or the share that update_mask names, on one of the caller’s own searches. A user stars at most 50; unstarring makes the search the most recently used.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Path parameters

idstringRequired1-255 characters
Identifier of the resource, assigned by Edulead and opaque to callers.

Headers

Edulead-TeamstringRequired

Query parameters

update_maskstringOptional
Which fields of the resource to change. Fields not listed keep their values.

Request

This endpoint expects an object.
idstringOptional<=255 characters
Identifier of the resource, assigned by Edulead and opaque to callers.
namestringOptional<=1000 characters

The search’s name, trimmed; required when updated.

entityenumOptional

enum.defined_only = true

Allowed values:
sourcestringOptional<=50 characters

The console page it ran on: PEOPLE_SEARCH or INSTITUTIONS_SEARCH; empty when not recorded.

querystringOptional<=100000 characters

The console URL query that runs it again: q (the filters, base64), sortBy, sortDir, page.

starredbooleanOptional
Starred by its owner.
sharedbooleanOptional
Shared with the team.
owner_idstringOptional<=255 characters

The user who ran it; only they may change it.

sharer_idstringOptional<=255 characters

The user who shared it; empty when not shared.

last_used_timedatetimeOptional
When it was last run, or last unstarred.
create_timedatetimeOptional
When Edulead created the resource.
update_timedatetimeOptional
When any field last changed.

Response

Success
searchobjectOptional
Search is a saved search.