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.
AddressInput
Provides the input structure for addresses within the Open Social Community Management System. The required format of the address depends on the country the address is in.
Input fields for AddressInput
| Name | Description |
|---|---|
countryCode (String!) | The two-letter code identifying the country of the address. Represents the country (or dependent territory) using the standard ISO 3166-1 alpha-2 code (for example "NL" for the Netherlands, "US" for the United States, "JP" for Japan). |
administrativeArea (String) | The main sub-division of a country (e.g. a state, province, region, etc.). Used to specify the top-level region within a country that helps to identify the address (for example "CA" for California in the US, "ON" for Ontario in Canada). |
locality (String) | The city, town or post-town of the address. Used to capture the primary populated place (city/district) within the administrative area where the address is located. |
dependentLocality (String) | A smaller division within the locality — e.g. suburb, neighbourhood, district or other sub-area. Used when finer-grained locality information is needed (for instance a neighborhood, borough or suburb within a city), where supported by the country's address format. |
postalCode (String) | The postal (ZIP / postcode) code of the address. Used to specify the code assigned by the national postal system for the delivery area — helps ensure mail and packages are routed correctly. |
addressLine1 (String) | The primary street address line — e.g. street name, house number. Used to capture the main part of the street-level address (street name, number, building name or other primary delivery location descriptor). |
addressLine2 (String) | A secondary address line for additional street-level details. Used for optional extra information that complements addressLine1 (e.g. apartment, unit, floor, suite, building name, care-of, or other delivery instructions), where needed. |
ContentInGroupInput
Input to set the groups of a piece of content.
Input fields for ContentInGroupInput
| Name | Description |
|---|---|
group (ID!) | The group that owns the content. |
crosspostedGroups ([ID!]) | That field only be used if the crossposted feature is enable at flexible_group configuration. The other groups that may view the content. Must not include the group that owns the content. Only applicable when the crossposted feature is enabled for HUBs. Should not list the group that owns the content. |
ContentInOrganizationInput
Input to set the organization of a piece of content.
Input fields for ContentInOrganizationInput
| Name | Description |
|---|---|
organization (ID!) | The organization this content should belong to if any. It is required that given content type is allowed in organization settings. |
crosspostedOrganizations ([ID!]) | The other organizations this content should be cross-posted to if any. It is required that given content type is allowed in organization settings. |
CreateEventInput
Input for creating a new event.
Input fields for CreateEventInput
| Name | Description |
|---|---|
clientMutationId (UUIDv4) | A unique identifier for the client performing the mutation. |
type (ID) | The type of the event. The ID of the event type as provided by Query.eventTypes. If omitted, the event has no event type. |
title (String!) | The display title of the event. |
visibility (ContentVisibility!) | The visibility of the event determines what users can view this event. |
body (RichTextJSON!) | The body of the event in Open Social Rich Text JSON Exchange format. |
startDate (Timestamp!) | The unix timestamp start date of the event. |
endDate (Timestamp!) | The unix timestamp end date of the event. |
location (String) | The location of the event as plain text. |
address (AddressInput) | The address of the event. |
groups (ContentInGroupInput) | The groups this event should belong to, if any. |
organizations (ContentInOrganizationInput) | The organization this event should belong to if any. May optionally be posted to additional organizations. |
contentTags ([ID!]) | Content tags associated with the event (optional). If provided, each tag ID must be valid. |
CreateTopicInput
Input for creating a new topic.
Input fields for CreateTopicInput
| Name | Description |
|---|---|
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. |
body (RichTextJSON!) | The body of the topic in Open Social Rich Text JSON Exchange format. |
groups (ContentInGroupInput) | The groups this topic should belong to, if any. A topic may be posted to one or more groups. |
organizations (ContentInOrganizationInput) | The organization this topic should belong to if any. May optionally be posted to additional organizations. |
contentTags ([ID!]) | Content tags associated with the topic (optional). If provided, each tag ID must be valid. |
DeleteEventInput
Input for deleting an existing event.
Input fields for DeleteEventInput
| Name | Description |
|---|---|
clientMutationId (UUIDv4) | A unique identifier for the client performing the mutation. |
id (ID!) | The event being deleted. |
DeleteTopicInput
Input for deleting an existing topic.
Input fields for DeleteTopicInput
| Name | Description |
|---|---|
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
| Name | Description |
|---|---|
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
| Name | Description |
|---|---|
value (String) |
UpdateEventInput
Input fields for UpdateEventInput
| Name | Description |
|---|---|
clientMutationId (UUIDv4) | A unique identifier for the client performing the mutation. |
id (ID!) | The event being edited. |
type (ID) | The type of the event. The ID of the event type as provided by Query.eventTypes. If omitted, the type remains unchanged. If null, the event type is cleared. |
title (String) | The display title of the event. If omitted, the title remains unchanged. |
visibility (ContentVisibility) | The visibility of the event determines what users can view this event. If omitted, visibility remains unchanged. |
body (RichTextJSON) | The body of the event in Open Social Rich Text JSON Exchange format. If omitted, the body remains unchanged. |
startDate (Timestamp) | The unix timestamp start date of the event. If omitted, start date remains unchanged. |
endDate (Timestamp) | The unix timestamp end date of the event. If omitted, end date remains unchanged. |
location (String) | The location of the event as plain text, this is not the address field, see "address". If omitted, event location remains unchanged. If null, the location is cleared. |
address (AddressInput) | The address of the event. If omitted, event address remains unchanged. If null, the address is cleared. |
groups (ContentInGroupInput) | The groups this event should belong to. Omit = unchanged; null = remove from all; ContentInGroupInput = set groups. |
organizations (ContentInOrganizationInput) | The organizations this event should belong to. Omit = unchanged; null = remove from all; ContentInOrganizationInput = set organizations. |
contentTags ([ID!]) | The tag(s) of the event. The ID of the event tag(s) as provided by contentTagCategories. If omitted, the content tag remains unchanged. |
UpdateTopicInput
Input for updating an existing topic.
Input fields for UpdateTopicInput
| Name | Description |
|---|---|
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. |
body (RichTextJSON) | The body of the topic in Open Social Rich Text JSON Exchange format. If omitted, the body remains unchanged. |
groups (ContentInGroupInput) | The groups this topic should belong to. Omit = unchanged; null = remove from all; ContentInGroupInput = set groups. |
organizations (ContentInOrganizationInput) | The organization this topic should belong to if any. May optionally be posted to additional organizations. If omitted, organizations remain unchanged. To remove the topic from all organizations, set: organizations: null. |
contentTags ([ID!]) | The tag(s) of the topic. The ID of the topic tag(s) as provided by contentTagCategories. If omitted, the content tag remains unchanged. |