Input objects

Input objects can be described as "composable objects" because they include a set of input fields that define the object.

About input objects

Input objects can be described as "composable objects" because they include a set of input fields that define the object.

For example, CommitAuthor takes a field called emails. Providing a value for emails transforms CommitAuthor into a list of User objects containing that email address. Note that objects may have input objects, whereas mutations require input objects.

For more information, see Form calls with GraphQL.

CreateTopicInput

Input for creating a new topic.

Input fields for CreateTopicInput

NameDescription
clientMutationId (UUIDv4)

A unique identifier for the client performing the mutation. Must be a valid UUIDv4 format.

type (ID!)

The type of the topic. Must be a valid topic type ID.

title (String!)

The title of the topic (max 255 characters).

visibility (ContentVisibility!)

The visibility of the topic.

DeleteTopicInput

Input for deleting an existing topic.

Input fields for DeleteTopicInput

NameDescription
clientMutationId (UUIDv4)

A unique identifier for the client performing the mutation.

id (ID!)

The topic being deleted.

OptionalPhoneNumber

An optional phone number.

Must be a valid phone number in the format [+country-prefix]<number>.

Used on input fields that require discerning between not-updating the field value and setting the field to NULL.

Input fields for OptionalPhoneNumber

NameDescription
value (PhoneNumber)

OptionalString

An optional string.

Used on input fields that require discerning between not-updating the field value and setting the field to NULL.

Input fields for OptionalString

NameDescription
value (String)

UpdateTopicInput

Input for updating an existing topic.

Input fields for UpdateTopicInput

NameDescription
clientMutationId (UUIDv4)

A unique identifier for the client performing the mutation. Must be a valid UUIDv4 format.

id (ID!)

The ID of the topic to update.

type (ID)

The type of the topic. Must be a valid topic type ID.

title (String)

The title of the topic (max 255 characters).

visibility (ContentVisibility)

The visibility of the topic.