addStarToScheduledSearch( )

Attention

Under Development

Our GraphQL pages are currently under development. The content, links, tables, and structure of this material may change without notice.

The addstartoscheduledsearch GraphQL mutation field is used to add a star to a scheduled search.

For more information on scheduled searches, see the Scheduled Searches documentation page.

Syntax

Below is the syntax for the addstartoscheduledsearch mutation field:

addStarToScheduledSearch(input: AddStarScheduledSearch!): ScheduledSearch!
Given Datatypes

For the input (i.e., AddStarScheduledSearch), there are a couple of parameters that may be given. Below is a list of them and a description of each:

Table: AddStarScheduledSearch

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier of the scheduled search.
viewNamestringyes input addstarscheduledsearch The name of the view of the scheduled search.

[a] Some arguments may be required, as indicated in this column. For some fields this column indicates that a result will always being returned for it.


The given datatype has its own special datatypes. You can click on the links below for more information on its parameters: