The addStarToField() GraphQL mutation is used to add a star to a field.

For more information on fields, see the Event Fields documentation page.

Syntax

Below is the syntax for the addStarToField() mutation field:

graphql
addStarToField(
      input: AddStarToFieldInput!
   ): AddStarToFieldMutation!

Given Datatypes

Within the parameters of the addStarToField() input, there are a some special datatypes, besides the standard ones (e.g., string). Below are tables listing the parameters of those datatypes.

The first parameter to provide when using the addStarToField() mutation, is the AddStarToFieldInput input. The parameters for it are listed in the table below, along with their datatype and a description of each.

Table: AddStarToFieldInput

ParameterTypeRequired[a]DefaultDescription
fieldNamestringyes The name of the field to mark with a star.
searchDomainNamestringyes The search domain where the field can be found.

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


Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, AddStarToFieldMutation. Below is a list of the parameters of that datatype:

Table: AddStarToFieldMutation

ParameterTypeRequired[a]DefaultDescription
starredFields[string]yes The fields on which to add stars.

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