Elium's GraphQL Schema
Queries
instance
Description
Get information about the global Instance configuration and settings
Response
Returns an
Instance
Example
Query
query instance {
instance {
actions {
...InstanceActionsFragment
}
availablePlans {
...InstancePlanFragment
}
baseUrl
chargebee {
...InstanceChargebeeFragment
}
configuration {
...InstanceConfigurationFragment
}
contacts {
...InstanceContactsFragment
}
contentLanguages
contentLangs {
...LanguageFragment
}
datadogRUM {
...InstanceDatadogRUMFragment
}
disabledStandardContent
disabledUsersForSuccession {
...UserConnectionFragment
}
duplicatedAssets {
...DuplicatedAssetConnectionFragment
}
disclaimer
domain
downloadLimits {
...InstanceDownloadLimitsFragment
}
emailPipelines {
...EmailPipelineConnectionFragment
}
features {
...InstanceFeaturesFragment
}
exportCSVRole
activityDigestFrequency
fullstory {
...InstanceFullstoryFragment
}
googleAnalytics {
...InstanceGoogleAnalyticsFragment
}
graphqlSubscriptionsUrl
graphqlVersion
hubspot {
...InstanceHubspotFragment
}
id
intercom {
...InstanceIntercomFragment
}
labFeatures {
...LabFeatureFragment
}
limits {
...InstanceLimitsFragment
}
mailto
microsoftTeams {
...InstanceMicrosoftTeamsFragment
}
mixpanel {
...InstanceMixpanelFragment
}
name
onboardingCompleted
onboardingCompletedSteps
realtimeUrl
refiner {
...InstanceRefinerFragment
}
release
passwordSettings {
...InstancePasswordSettingsFragment
}
sandboxGapiUrl
sandboxOneDrivePickerUrl
sandboxUrl
sharePoint {
...InstanceSharePointFragment
}
officeOnline
slack {
...InstanceSlackFragment
}
spaceGroups {
...SpaceGroupConnectionFragment
}
ssoConfig {
...InstanceSsoConfigFragment
}
scimConfig {
...InstanceScimConfigFragment
}
connectedApps {
...ConnectedAppConnectionFragment
}
approvals {
...StoryApprovalConnectionFragment
}
publicSharedStories {
...StoryConnectionFragment
}
spaces {
...SpaceConnectionFragment
}
statistics {
...InstanceStatisticsFragment
}
subscription {
...InstanceSubscriptionFragment
}
answerFeedbacks {
...AnswerConnectionFragment
}
answerFeedbacksExport
searchFeedbacks {
...SearchFeedbackConnectionFragment
}
sharedAlerts {
...AlertConnectionFragment
}
summaryStats
successorsWithContent {
...UserConnectionFragment
}
timezones
teams {
...TeamConnectionFragment
}
theme {
...InstanceThemeFragment
}
uiLanguage
uiLanguages
uiLangs {
...LanguageFragment
}
usage {
...InstanceUsageFragment
}
uuid
workplace {
...InstanceWorkplaceFragment
}
exports {
...InstanceExportConnectionFragment
}
appLaunchers {
...AppLauncherConnectionFragment
}
smartFeeds {
...SmartFeedConnectionFragment
}
organizations {
...OrganizationFragment
}
}
}
Response
{
"data": {
"instance": {
"actions": InstanceActions,
"availablePlans": [InstancePlan],
"baseUrl": "http://www.test.com/",
"chargebee": InstanceChargebee,
"configuration": InstanceConfiguration,
"contacts": InstanceContacts,
"contentLanguages": [{}],
"contentLangs": [Language],
"datadogRUM": InstanceDatadogRUM,
"disabledStandardContent": ["xyz789"],
"disabledUsersForSuccession": UserConnection,
"duplicatedAssets": DuplicatedAssetConnection,
"disclaimer": true,
"domain": "abc123",
"downloadLimits": InstanceDownloadLimits,
"emailPipelines": EmailPipelineConnection,
"features": InstanceFeatures,
"exportCSVRole": "ADMINISTRATOR",
"activityDigestFrequency": "DEFAULT",
"fullstory": InstanceFullstory,
"googleAnalytics": InstanceGoogleAnalytics,
"graphqlSubscriptionsUrl": "http://www.test.com/",
"graphqlVersion": "abc123",
"hubspot": InstanceHubspot,
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"intercom": InstanceIntercom,
"labFeatures": [LabFeature],
"limits": InstanceLimits,
"mailto": "test@test.com",
"microsoftTeams": InstanceMicrosoftTeams,
"mixpanel": InstanceMixpanel,
"name": "xyz789",
"onboardingCompleted": true,
"onboardingCompletedSteps": [
"abc123"
],
"realtimeUrl": "http://www.test.com/",
"refiner": InstanceRefiner,
"release": "xyz789",
"passwordSettings": InstancePasswordSettings,
"sandboxGapiUrl": "http://www.test.com/",
"sandboxOneDrivePickerUrl": "http://www.test.com/",
"sandboxUrl": "http://www.test.com/",
"sharePoint": InstanceSharePoint,
"officeOnline": false,
"slack": InstanceSlack,
"spaceGroups": SpaceGroupConnection,
"ssoConfig": InstanceSsoConfig,
"scimConfig": InstanceScimConfig,
"connectedApps": ConnectedAppConnection,
"approvals": StoryApprovalConnection,
"publicSharedStories": StoryConnection,
"spaces": SpaceConnection,
"statistics": InstanceStatistics,
"subscription": InstanceSubscription,
"answerFeedbacks": AnswerConnection,
"answerFeedbacksExport": "http://www.test.com/",
"searchFeedbacks": SearchFeedbackConnection,
"sharedAlerts": AlertConnection,
"summaryStats": {},
"successorsWithContent": UserConnection,
"timezones": [Timezone],
"teams": TeamConnection,
"theme": InstanceTheme,
"uiLanguage": "fr",
"uiLanguages": [{}],
"uiLangs": [Language],
"usage": InstanceUsage,
"uuid": "abc123",
"workplace": InstanceWorkplace,
"exports": InstanceExportConnection,
"appLaunchers": AppLauncherConnection,
"smartFeeds": SmartFeedConnection,
"organizations": [Organization]
}
}
}
instanceActivationToken
Description
Get informations about InstanceActivation using a Token. Used only when creating a free trial
Response
Returns an
InstanceActivationToken
Arguments
| Name | Description |
|---|---|
token -
UUID!
|
Example
Query
query instanceActivationToken($token: UUID!) {
instanceActivationToken(token: $token) {
email
errorCode
lang
mixpanelToken
mixpanelHost
}
}
Variables
{
"token": "ac1297c7-d923-412b-afb2-b9183bcb905b"
}
Response
{
"data": {
"instanceActivationToken": {
"email": "test@test.com",
"errorCode": "EXISTING_USER",
"lang": "xyz789",
"mixpanelToken": "abc123",
"mixpanelHost": "abc123"
}
}
}
instanceAuth
Description
Information for the different Authentication methods and related login screen
Response
Returns an
InstanceAuthentication
Example
Query
query instanceAuth {
instanceAuth {
basic {
...InstanceAuthenticationMethodFragment
}
disclaimers {
...TranslatedRichContentFragment
}
hasDisclaimer
instanceName
uuid
accentColor
headerColor
headerTextLightness
logoImageUrl
introText
isCustomDisclaimer
mobileEnabled
mixpanel {
...PublicInstanceMixpanelFragment
}
saml2 {
...InstanceAuthenticationMethodFragment
}
sso {
...InstanceAuthenticationMethodFragment
}
}
}
Response
{
"data": {
"instanceAuth": {
"basic": InstanceAuthenticationMethod,
"disclaimers": [TranslatedRichContent],
"hasDisclaimer": false,
"instanceName": "abc123",
"uuid": "xyz789",
"accentColor": "#CCCCCC",
"headerColor": "#CCCCCC",
"headerTextLightness": "DARK",
"logoImageUrl": "http://www.test.com/",
"introText": "<html>Hello <h1>world</h1></html>",
"isCustomDisclaimer": true,
"mobileEnabled": true,
"mixpanel": PublicInstanceMixpanel,
"saml2": InstanceAuthenticationMethod,
"sso": InstanceAuthenticationMethod
}
}
}
integrations
Description
Get all integrations of the instance
Response
Returns an
Integrations
Example
Query
query integrations {
integrations {
microsoftTeams {
...MicrosoftTeamsIntegrationFragment
}
slack {
...SlackIntegrationFragment
}
sharePoint {
...SharePointIntegrationFragment
}
}
}
Response
{
"data": {
"integrations": {
"microsoftTeams": MicrosoftTeamsIntegration,
"slack": SlackIntegration,
"sharePoint": SharePointIntegration
}
}
}
me
Description
The currently authenticated user.
Response
Returns a
Me
Example
Query
query me {
me {
actions {
...MeActionsFragment
}
activities {
...ActivityConnectionFragment
}
aiCompletion
alerts {
...AlertFragment
}
analytics {
...MeAnalyticsFragment
}
answer {
...MeAnswerFragment
}
appLaunchers {
...AppLauncherFragment
}
bookmarks {
...StoryConnectionFragment
}
boxes {
...BoxFragment
}
completeStories {
...StoryFragment
}
contentFeed {
...StoryConnectionFragment
}
contentFromSuccessions {
...StoryConnectionFragment
}
deviceTokens {
...MeDeviceTokenFragment
}
directory {
...DirectorySearchResponseFragment
}
drafts {
...StoryConnectionFragment
}
events {
...StoryConnectionFragment
}
facets {
...FacetFragment
}
feed {
...ActivityFeedItemConnectionFragment
}
globalPinnedStories {
...StoryFragment
}
globalSchemaAttributes {
...SchemaAttributeFragment
}
id
mention {
... on User {
...UserFragment
}
... on Space {
...SpaceFragment
}
... on Team {
...TeamFragment
}
}
myContent {
...StoryConnectionFragment
}
notifications {
...NotificationConnectionFragment
}
notificationsPreferences {
...MeNotificationsPreferencesFragment
}
personalContent {
...StoryConnectionFragment
}
preferences {
...MePreferencesFragment
}
presenceToken
quickSearch {
...QuickSearchResponseFragment
}
schemas {
...StorySchemaFragment
}
search {
...StorySearchResponseFragment
}
searchGlobalTags {
...TagResultFragment
}
searchHashtags {
...HashtagResultFragment
}
smartFeeds {
...SmartFeedConnectionFragment
}
spaceGroups {
...SpaceGroupConnectionFragment
}
spaces {
...SpaceConnectionFragment
}
storiesByAsset {
...StoryFragment
}
subscriptionToken
unreadDiscussionsCount
user {
...UserFragment
}
}
}
Response
{
"data": {
"me": {
"actions": MeActions,
"activities": ActivityConnection,
"aiCompletion": "abc123",
"alerts": [Alert],
"analytics": MeAnalytics,
"answer": MeAnswer,
"appLaunchers": [AppLauncher],
"bookmarks": StoryConnection,
"boxes": [Box],
"completeStories": [Story],
"contentFeed": StoryConnection,
"contentFromSuccessions": StoryConnection,
"deviceTokens": [MeDeviceToken],
"directory": DirectorySearchResponse,
"drafts": StoryConnection,
"events": StoryConnection,
"facets": [Facet],
"feed": ActivityFeedItemConnection,
"globalPinnedStories": [Story],
"globalSchemaAttributes": [SchemaAttribute],
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"mention": [User],
"myContent": StoryConnection,
"notifications": NotificationConnection,
"notificationsPreferences": MeNotificationsPreferences,
"personalContent": StoryConnection,
"preferences": MePreferences,
"presenceToken": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"quickSearch": QuickSearchResponse,
"schemas": [StorySchema],
"search": StorySearchResponse,
"searchGlobalTags": [TagResult],
"searchHashtags": [HashtagResult],
"smartFeeds": SmartFeedConnection,
"spaceGroups": SpaceGroupConnection,
"spaces": SpaceConnection,
"storiesByAsset": [Story],
"subscriptionToken": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"unreadDiscussionsCount": 987,
"user": User
}
}
}
node
Description
Get any node object via the Graphql unique ID
nodes
Description
Get a list of node objects via their ids. see node resolver
organization
Description
Get an organization via the the subdomain
Response
Returns an
Organization
Arguments
| Name | Description |
|---|---|
subdomain -
String!
|
Example
Query
query organization($subdomain: String!) {
organization(subdomain: $subdomain) {
id
subdomain
name
created
saml2Enabled
transparentAuth
allowCreate
metadata
assertionsSigned
messagesSigned
signatureAlgorithm
digestAlgorithm
}
}
Variables
{"subdomain": "abc123"}
Response
{
"data": {
"organization": {
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"subdomain": "xyz789",
"name": "xyz789",
"created": "2016-10-07T01:08:03.420Z",
"saml2Enabled": true,
"transparentAuth": false,
"allowCreate": false,
"metadata": "xyz789",
"assertionsSigned": false,
"messagesSigned": true,
"signatureAlgorithm": "RSA_SHA1",
"digestAlgorithm": "SHA1"
}
}
}
publicInstance
Description
Publicly available Instance informations you must provide a valid access token to access it
Response
Returns a
PublicInstance
Arguments
| Name | Description |
|---|---|
token -
String!
|
Example
Query
query publicInstance($token: String!) {
publicInstance(token: $token) {
name
uuid
accentColor
headerColor
headerTextLightness
logoImageUrl
googleAnalyticsTrackingId
baseUrl
domain
release
mixpanel {
...PublicInstanceMixpanelFragment
}
sandboxUrl
}
}
Variables
{"token": "xyz789"}
Response
{
"data": {
"publicInstance": {
"name": "abc123",
"uuid": "abc123",
"accentColor": "#CCCCCC",
"headerColor": "#CCCCCC",
"headerTextLightness": "DARK",
"logoImageUrl": "http://www.test.com/",
"googleAnalyticsTrackingId": "xyz789",
"baseUrl": "http://www.test.com/",
"domain": "abc123",
"release": "abc123",
"mixpanel": PublicInstanceMixpanel,
"sandboxUrl": "http://www.test.com/"
}
}
}
publicStory
Description
Fetch a publicly shared content by token and lang
Response
Returns a
PublicStory
Example
Query
query publicStory(
$token: String!,
$lang: Lang
) {
publicStory(
token: $token,
lang: $lang
) {
lang
availableLangs
assets {
...PublicAssetFragment
}
mainAsset {
...PublicAssetFragment
}
layoutMode
hideReadTime
body {
...RichContentFragment
}
created
title
attributes {
...PublicAttributeFragment
}
}
}
Variables
{
"token": "abc123",
"lang": "fr"
}
Response
{
"data": {
"publicStory": {
"lang": "fr",
"availableLangs": [{}],
"assets": [PublicAsset],
"mainAsset": PublicAsset,
"layoutMode": "SMALL",
"hideReadTime": true,
"body": RichContent,
"created": "2016-10-07T01:08:03.420Z",
"title": "xyz789",
"attributes": [PublicAttribute]
}
}
}
space
Description
Get a space via the the slug (integer id)
Example
Query
query space($slug: Int!) {
space(slug: $slug) {
actions {
...SpaceActionsFragment
}
activities {
...ActivityConnectionFragment
}
administrators {
...UserConnectionFragment
}
approvers {
...UserConnectionFragment
}
approvals {
...StoryApprovalConnectionFragment
}
additionalViewsStories {
...StoryConnectionFragment
}
adminsCount
analytics {
...SpaceAnalyticsFragment
}
backdrop
boxes {
...BoxFragment
}
color
contentFeed {
...StoryConnectionFragment
}
contentStats {
...SpaceContentStatsFragment
}
defaultExpiration
defaultRole
deletedStories {
...DeletedStoryConnectionFragment
}
description
descriptions
directory {
...DirectorySearchResponseFragment
}
facets {
...FacetFragment
}
feed {
...ActivityFeedItemConnectionFragment
}
headerImage
headerImageDigest
id
intro {
...RichContentFragment
}
intros {
...TranslatedRichContentFragment
}
isDefault
isApprovalMandatory
meRole
meFavorited
membersAddCompletion {
... on User {
...UserFragment
}
... on Team {
...TeamFragment
}
... on Space {
...SpaceFragment
}
}
membersCount
membersDownload
name
names
notifyAdminsOnPost
notifyMembersOnPost
pendingMembers {
...UserFragment
}
pinnedStories {
...StoryFragment
}
previewImage
promoted
promotedImage
promotedImageDigest
rootFolder {
...FolderFragment
}
schemas {
...StorySchemaFragment
}
search {
...StorySearchResponseFragment
}
showEmbeddedWebsite
showPopularTiles
showPopularUsers
showRecentUsers
showRecomendedUsers
showTopContributors
slug
spaceGroup {
...SpaceGroupFragment
}
spaceMembers {
...SpaceMemberConnectionFragment
}
spaceUsers {
...UserConnectionFragment
}
status
suggestedTags {
...TagFragment
}
tabs {
...SpaceTabFragment
}
tags {
...TagFragment
}
thumbnailImage
thumbnailImageDigest
type
}
}
Variables
{"slug": 987}
Response
{
"data": {
"space": {
"actions": SpaceActions,
"activities": ActivityConnection,
"administrators": UserConnection,
"approvers": UserConnection,
"approvals": StoryApprovalConnection,
"additionalViewsStories": StoryConnection,
"adminsCount": 123,
"analytics": SpaceAnalytics,
"backdrop": false,
"boxes": [Box],
"color": "#CCCCCC",
"contentFeed": StoryConnection,
"contentStats": SpaceContentStats,
"defaultExpiration": "ONE_MONTH",
"defaultRole": "ADMIN",
"deletedStories": DeletedStoryConnection,
"description": "abc123",
"descriptions": {"en": "a Name", "fr": "Un Nom"},
"directory": DirectorySearchResponse,
"facets": [Facet],
"feed": ActivityFeedItemConnection,
"headerImage": "http://www.test.com/",
"headerImageDigest": "xyz789",
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"intro": RichContent,
"intros": [TranslatedRichContent],
"isDefault": false,
"isApprovalMandatory": false,
"meRole": "ADMIN",
"meFavorited": true,
"membersAddCompletion": [User],
"membersCount": 987,
"membersDownload": "http://www.test.com/",
"name": "xyz789",
"names": {"en": "a Name", "fr": "Un Nom"},
"notifyAdminsOnPost": true,
"notifyMembersOnPost": true,
"pendingMembers": [User],
"pinnedStories": [Story],
"previewImage": "http://www.test.com/",
"promoted": ["NOT_PROMOTED"],
"promotedImage": "http://www.test.com/",
"promotedImageDigest": "xyz789",
"rootFolder": Folder,
"schemas": [StorySchema],
"search": StorySearchResponse,
"showEmbeddedWebsite": "http://www.test.com/",
"showPopularTiles": true,
"showPopularUsers": true,
"showRecentUsers": false,
"showRecomendedUsers": true,
"showTopContributors": false,
"slug": 123,
"spaceGroup": SpaceGroup,
"spaceMembers": SpaceMemberConnection,
"spaceUsers": UserConnection,
"status": "CLOSED",
"suggestedTags": [Tag],
"tabs": [SpaceTab],
"tags": [Tag],
"thumbnailImage": "http://www.test.com/",
"thumbnailImageDigest": "xyz789",
"type": "PERSONAL"
}
}
}
spaceGroup
Description
Get a space group via the slug (integer id)
Response
Returns a
SpaceGroup
Arguments
| Name | Description |
|---|---|
slug -
ID!
|
Example
Query
query spaceGroup($slug: ID!) {
spaceGroup(slug: $slug) {
actions {
...SpaceGroupActionsFragment
}
backdrop
color
headerImage
headerImageDigest
id
name
names
slug
spaces {
...SpaceConnectionFragment
}
thumbnailImage
thumbnailImageDigest
}
}
Variables
{"slug": "eWVhaCByaWdodCBpdCdzIGI2NA=="}
Response
{
"data": {
"spaceGroup": {
"actions": SpaceGroupActions,
"backdrop": false,
"color": "#CCCCCC",
"headerImage": "http://www.test.com/",
"headerImageDigest": "xyz789",
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"name": "abc123",
"names": {"en": "a Name", "fr": "Un Nom"},
"slug": "abc123",
"spaces": SpaceConnection,
"thumbnailImage": "http://www.test.com/",
"thumbnailImageDigest": "abc123"
}
}
}
statusStory
Description
Get a story or a status(kp3) via the slug
Example
Query
query statusStory($slug: Int!) {
statusStory(slug: $slug) {
actions {
...StoryActionsFragment
}
added
analytics {
...StoryAnalyticsFragment
}
bookmarked
approval {
...StoryApprovalFragment
}
commenters {
...UserConnectionFragment
}
comments {
...CommentConnectionFragment
}
contributors {
...UserConnectionFragment
}
diffVersions {
...StoryVersionsDiffFragment
}
editVersion {
...StoryVersionFragment
}
editVersionUUID
event {
...EventFragment
}
expireAt
followed
followers {
...UserConnectionFragment
}
globallyPinned
grants {
...StoryGrantFragment
}
hasSpace
hashtags {
...HashtagFragment
}
id
invitables {
...InvitableConnectionFragment
}
invitations {
...InvitationConnectionFragment
}
inviteContributors {
...UserFragment
}
isPublished
isSpaceClosed
lastExpiration {
...StoryExpirationHistoryFragment
}
layoutMode
hideReadTime
legacy
liked
likers {
...UserConnectionFragment
}
pinned
publicUrl
publicSharedBy {
...UserFragment
}
publicShared
relateds {
...StoryConnectionFragment
}
reshared
resharedAs {
...StoryFragment
}
resharedAsCount
resharedFrom {
...StoryFragment
}
restricted
schema {
...StorySchemaFragment
}
confidentialContent
share {
...ShareFragment
}
slug
space {
...SpaceFragment
}
status
subscriptionToken
suggestedTags {
...TagFragment
}
tags {
...TagFragment
}
type
updated
user {
...UserFragment
}
usersPermission {
...UserFragment
}
valid
version {
...StoryVersionFragment
}
versions {
...StoryVersionConnectionFragment
}
viewers {
...UserConnectionFragment
}
visibility
watchToken
lock {
...StoryLockFragment
}
}
}
Variables
{"slug": 987}
Response
{
"data": {
"statusStory": {
"actions": StoryActions,
"added": "2016-10-07T01:08:03.420Z",
"analytics": StoryAnalytics,
"bookmarked": false,
"approval": StoryApproval,
"commenters": UserConnection,
"comments": CommentConnection,
"contributors": UserConnection,
"diffVersions": StoryVersionsDiff,
"editVersion": StoryVersion,
"editVersionUUID": "ac1297c7-d923-412b-afb2-b9183bcb905b",
"event": Event,
"expireAt": "2016-10-07T01:08:03.420Z",
"followed": false,
"followers": UserConnection,
"globallyPinned": true,
"grants": [StoryGrant],
"hasSpace": false,
"hashtags": [Hashtag],
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"invitables": InvitableConnection,
"invitations": InvitationConnection,
"inviteContributors": [User],
"isPublished": true,
"isSpaceClosed": false,
"lastExpiration": StoryExpirationHistory,
"layoutMode": "SMALL",
"hideReadTime": true,
"legacy": true,
"liked": true,
"likers": UserConnection,
"pinned": false,
"publicUrl": "http://www.test.com/",
"publicSharedBy": User,
"publicShared": "2016-10-07T01:08:03.420Z",
"relateds": StoryConnection,
"reshared": false,
"resharedAs": [Story],
"resharedAsCount": 123,
"resharedFrom": Story,
"restricted": true,
"schema": StorySchema,
"confidentialContent": false,
"share": Share,
"slug": 123,
"space": Space,
"status": "ARCHIVED",
"subscriptionToken": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"suggestedTags": [Tag],
"tags": [Tag],
"type": "abc123",
"updated": "2016-10-07T01:08:03.420Z",
"user": User,
"usersPermission": [User],
"valid": false,
"version": StoryVersion,
"versions": StoryVersionConnection,
"viewers": UserConnection,
"visibility": "PRIVATE",
"watchToken": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"lock": StoryLock
}
}
}
story
Description
Get a story via its slug (integer id)
Example
Query
query story($slug: Int!) {
story(slug: $slug) {
actions {
...StoryActionsFragment
}
added
analytics {
...StoryAnalyticsFragment
}
bookmarked
approval {
...StoryApprovalFragment
}
commenters {
...UserConnectionFragment
}
comments {
...CommentConnectionFragment
}
contributors {
...UserConnectionFragment
}
diffVersions {
...StoryVersionsDiffFragment
}
editVersion {
...StoryVersionFragment
}
editVersionUUID
event {
...EventFragment
}
expireAt
followed
followers {
...UserConnectionFragment
}
globallyPinned
grants {
...StoryGrantFragment
}
hasSpace
hashtags {
...HashtagFragment
}
id
invitables {
...InvitableConnectionFragment
}
invitations {
...InvitationConnectionFragment
}
inviteContributors {
...UserFragment
}
isPublished
isSpaceClosed
lastExpiration {
...StoryExpirationHistoryFragment
}
layoutMode
hideReadTime
legacy
liked
likers {
...UserConnectionFragment
}
pinned
publicUrl
publicSharedBy {
...UserFragment
}
publicShared
relateds {
...StoryConnectionFragment
}
reshared
resharedAs {
...StoryFragment
}
resharedAsCount
resharedFrom {
...StoryFragment
}
restricted
schema {
...StorySchemaFragment
}
confidentialContent
share {
...ShareFragment
}
slug
space {
...SpaceFragment
}
status
subscriptionToken
suggestedTags {
...TagFragment
}
tags {
...TagFragment
}
type
updated
user {
...UserFragment
}
usersPermission {
...UserFragment
}
valid
version {
...StoryVersionFragment
}
versions {
...StoryVersionConnectionFragment
}
viewers {
...UserConnectionFragment
}
visibility
watchToken
lock {
...StoryLockFragment
}
}
}
Variables
{"slug": 987}
Response
{
"data": {
"story": {
"actions": StoryActions,
"added": "2016-10-07T01:08:03.420Z",
"analytics": StoryAnalytics,
"bookmarked": false,
"approval": StoryApproval,
"commenters": UserConnection,
"comments": CommentConnection,
"contributors": UserConnection,
"diffVersions": StoryVersionsDiff,
"editVersion": StoryVersion,
"editVersionUUID": "ac1297c7-d923-412b-afb2-b9183bcb905b",
"event": Event,
"expireAt": "2016-10-07T01:08:03.420Z",
"followed": true,
"followers": UserConnection,
"globallyPinned": true,
"grants": [StoryGrant],
"hasSpace": true,
"hashtags": [Hashtag],
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"invitables": InvitableConnection,
"invitations": InvitationConnection,
"inviteContributors": [User],
"isPublished": true,
"isSpaceClosed": true,
"lastExpiration": StoryExpirationHistory,
"layoutMode": "SMALL",
"hideReadTime": false,
"legacy": false,
"liked": false,
"likers": UserConnection,
"pinned": false,
"publicUrl": "http://www.test.com/",
"publicSharedBy": User,
"publicShared": "2016-10-07T01:08:03.420Z",
"relateds": StoryConnection,
"reshared": true,
"resharedAs": [Story],
"resharedAsCount": 123,
"resharedFrom": Story,
"restricted": false,
"schema": StorySchema,
"confidentialContent": false,
"share": Share,
"slug": 123,
"space": Space,
"status": "ARCHIVED",
"subscriptionToken": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"suggestedTags": [Tag],
"tags": [Tag],
"type": "xyz789",
"updated": "2016-10-07T01:08:03.420Z",
"user": User,
"usersPermission": [User],
"valid": true,
"version": StoryVersion,
"versions": StoryVersionConnection,
"viewers": UserConnection,
"visibility": "PRIVATE",
"watchToken": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"lock": StoryLock
}
}
}
storySchema
Description
Get a story schema via the slug
Response
Returns a
StorySchema
Arguments
| Name | Description |
|---|---|
slug -
Int!
|
Example
Query
query storySchema($slug: Int!) {
storySchema(slug: $slug) {
actions {
...StorySchemaActionsFragment
}
attributes {
... on SchemaSeparator {
...SchemaSeparatorFragment
}
... on SchemaAttribute {
...SchemaAttributeFragment
}
}
bodies {
...TranslatedRichContentFragment
}
body {
...RichContentFragment
}
builtins
color
coverAssetUsage
hasEvent
hasStructuredTitle
icon
id
installedGlobally
langs
mainAssetTypes
mainAssetUsage
name
names
placeholderTitle
placeholderTitles
slug
spaces {
...SpaceFragment
}
status
titleSeparator
}
}
Variables
{"slug": 123}
Response
{
"data": {
"storySchema": {
"actions": StorySchemaActions,
"attributes": [SchemaSeparator],
"bodies": [TranslatedRichContent],
"body": RichContent,
"builtins": ["AUTHOR"],
"color": "xyz789",
"coverAssetUsage": "HIDDEN",
"hasEvent": true,
"hasStructuredTitle": false,
"icon": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"installedGlobally": false,
"langs": ["fr"],
"mainAssetTypes": ["CLOUD_FILE"],
"mainAssetUsage": "HIDDEN",
"name": "abc123",
"names": {"en": "a Name", "fr": "Un Nom"},
"placeholderTitle": "abc123",
"placeholderTitles": {"en": "a Name", "fr": "Un Nom"},
"slug": 987,
"spaces": [Space],
"status": "DELETED",
"titleSeparator": "COLON"
}
}
}
user
Description
Get a user via the slug (integer id)
Example
Query
query user($slug: Int!) {
user(slug: $slug) {
actions {
...UserActionsFragment
}
attributes {
...AttributeFragment
}
banner
builtins {
...BuiltinAttributeFragment
}
downloadsCount
primaryEmail
userName
commonSpaces {
...SpaceConnectionFragment
}
contentCount
cover
coverDigest
description
feed {
...ActivityFeedItemConnectionFragment
}
followed
followers {
...UserConnectionFragment
}
following {
...UserConnectionFragment
}
hasTwoFactorEnabled
hashtags {
...HashtagFragment
}
id
lastVisit
spacesWithUserContent {
...SuccessionFragment
}
successorContentCount
memberSince
mustEnableTwoFactor
name
photo
photoDigest
presence {
...UserPresenceFragment
}
role
schema {
...UserSchemaFragment
}
search {
...StorySearchResponseFragment
}
slug
spaceContentCount
status
tags {
...TagFragment
}
twoFactorSetupDate
watchToken
}
}
Variables
{"slug": 123}
Response
{
"data": {
"user": {
"actions": UserActions,
"attributes": [Attribute],
"banner": "http://www.test.com/",
"builtins": [BuiltinAttribute],
"downloadsCount": 123,
"primaryEmail": "test@test.com",
"userName": "xyz789",
"commonSpaces": SpaceConnection,
"contentCount": 123,
"cover": "http://www.test.com/",
"coverDigest": "xyz789",
"description": "xyz789",
"feed": ActivityFeedItemConnection,
"followed": false,
"followers": UserConnection,
"following": UserConnection,
"hasTwoFactorEnabled": false,
"hashtags": [Hashtag],
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"lastVisit": "2016-10-07T01:08:03.420Z",
"spacesWithUserContent": [Succession],
"successorContentCount": 123,
"memberSince": "2016-10-07T01:08:03.420Z",
"mustEnableTwoFactor": true,
"name": "xyz789",
"photo": "http://www.test.com/",
"photoDigest": "xyz789",
"presence": [UserPresence],
"role": "ADMINISTRATOR",
"schema": UserSchema,
"search": StorySearchResponse,
"slug": 987,
"spaceContentCount": 987,
"status": "DELETED",
"tags": [Tag],
"twoFactorSetupDate": "2016-10-07T01:08:03.420Z",
"watchToken": "eWVhaCByaWdodCBpdCdzIGI2NA=="
}
}
}
Mutations
alertCreate
Description
Create an Alert based on search criterias
Response
Returns an
AlertCreatePayload
Arguments
| Name | Description |
|---|---|
input -
AlertCreateInput!
|
Example
Query
mutation alertCreate($input: AlertCreateInput!) {
alertCreate(input: $input) {
alert {
...AlertFragment
}
clientMutationId
me {
...MeFragment
}
errors {
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": AlertCreateInput}
Response
{
"data": {
"alertCreate": {
"alert": Alert,
"clientMutationId": "xyz789",
"me": Me,
"errors": [InvalidInputError]
}
}
}
alertDelete
Description
Delete an Alert
Response
Returns an
AlertDeletePayload
Arguments
| Name | Description |
|---|---|
input -
AlertDeleteInput!
|
Example
Query
mutation alertDelete($input: AlertDeleteInput!) {
alertDelete(input: $input) {
clientMutationId
me {
...MeFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": AlertDeleteInput}
Response
{
"data": {
"alertDelete": {
"clientMutationId": "xyz789",
"me": Me,
"errors": [ObjectNotFoundError]
}
}
}
alertEdit
Description
Edit an existing Alert
Response
Returns an
AlertEditPayload
Arguments
| Name | Description |
|---|---|
input -
AlertEditInput!
|
Example
Query
mutation alertEdit($input: AlertEditInput!) {
alertEdit(input: $input) {
alert {
...AlertFragment
}
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": AlertEditInput}
Response
{
"data": {
"alertEdit": {
"alert": Alert,
"clientMutationId": "xyz789",
"errors": [PermissionError]
}
}
}
alertSubscription
Description
Edit subscription (sending preferences) of an Alert
Response
Returns an
AlertSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input -
AlertSubscriptionInput!
|
Example
Query
mutation alertSubscription($input: AlertSubscriptionInput!) {
alertSubscription(input: $input) {
alert {
...AlertFragment
}
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": AlertSubscriptionInput}
Response
{
"data": {
"alertSubscription": {
"alert": Alert,
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError]
}
}
}
analyticsSignal
Description
Send signal about read or impression made by a user
Response
Returns an
AnalyticsSignalPayload
Arguments
| Name | Description |
|---|---|
input -
AnalyticsSignalInput!
|
Example
Query
mutation analyticsSignal($input: AnalyticsSignalInput!) {
analyticsSignal(input: $input) {
clientMutationId
}
}
Variables
{"input": AnalyticsSignalInput}
Response
{
"data": {
"analyticsSignal": {
"clientMutationId": "xyz789"
}
}
}
annotationCommentAdd
Description
Add a reply (AnnotationComment) to an Annotation requires AnnotationActions.reply
Response
Returns an
AnnotationCommentAddPayload
Arguments
| Name | Description |
|---|---|
input -
AnnotationCommentAddInput!
|
Example
Query
mutation annotationCommentAdd($input: AnnotationCommentAddInput!) {
annotationCommentAdd(input: $input) {
clientMutationId
annotation {
...AnnotationFragment
}
commentEdge {
...AnnotationCommentEdgeFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": AnnotationCommentAddInput}
Response
{
"data": {
"annotationCommentAdd": {
"clientMutationId": "abc123",
"annotation": Annotation,
"commentEdge": AnnotationCommentEdge,
"errors": [ObjectNotFoundError]
}
}
}
annotationCommentDelete
Description
Delete an AnnotationComment requires AnnotationCommentActions.delete
Response
Returns an
AnnotationCommentDeletePayload
Arguments
| Name | Description |
|---|---|
input -
AnnotationCommentDeleteInput!
|
Example
Query
mutation annotationCommentDelete($input: AnnotationCommentDeleteInput!) {
annotationCommentDelete(input: $input) {
clientMutationId
annotationCommentId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": AnnotationCommentDeleteInput}
Response
{
"data": {
"annotationCommentDelete": {
"clientMutationId": "abc123",
"annotationCommentId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"errors": [ObjectNotFoundError]
}
}
}
annotationCommentEdit
Description
Edit an AnnotationComment text content requires AnnotationCommentActions.edit
Response
Returns an
AnnotationCommentEditPayload
Arguments
| Name | Description |
|---|---|
input -
AnnotationCommentEditInput!
|
Example
Query
mutation annotationCommentEdit($input: AnnotationCommentEditInput!) {
annotationCommentEdit(input: $input) {
clientMutationId
comment {
...AnnotationCommentFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": AnnotationCommentEditInput}
Response
{
"data": {
"annotationCommentEdit": {
"clientMutationId": "xyz789",
"comment": AnnotationComment,
"errors": [ObjectNotFoundError]
}
}
}
annotationCreate
Description
Create an Annotation on a given Story requires StoryActions.annotate
Response
Returns an
AnnotationCreatePayload
Arguments
| Name | Description |
|---|---|
input -
AnnotationCreateInput!
|
Example
Query
mutation annotationCreate($input: AnnotationCreateInput!) {
annotationCreate(input: $input) {
clientMutationId
story {
...StoryFragment
}
annotationEdge {
...AnnotationEdgeFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": AnnotationCreateInput}
Response
{
"data": {
"annotationCreate": {
"clientMutationId": "xyz789",
"story": Story,
"annotationEdge": AnnotationEdge,
"errors": [ObjectNotFoundError]
}
}
}
annotationDelete
Description
Delete an Annotation requires AnnotationActions.delete
Response
Returns an
AnnotationDeletePayload
Arguments
| Name | Description |
|---|---|
input -
AnnotationDeleteInput!
|
Example
Query
mutation annotationDelete($input: AnnotationDeleteInput!) {
annotationDelete(input: $input) {
clientMutationId
annotationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": AnnotationDeleteInput}
Response
{
"data": {
"annotationDelete": {
"clientMutationId": "xyz789",
"annotationId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"errors": [ObjectNotFoundError]
}
}
}
annotationEdit
Description
Edit an exisiting Annotation on a story (resolve it or change the message for example) requires AnnotationActions.edit or requires AnnotationActions.resolve
Response
Returns an
AnnotationEditPayload
Arguments
| Name | Description |
|---|---|
input -
AnnotationEditInput!
|
Example
Query
mutation annotationEdit($input: AnnotationEditInput!) {
annotationEdit(input: $input) {
clientMutationId
annotation {
...AnnotationFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": AnnotationEditInput}
Response
{
"data": {
"annotationEdit": {
"clientMutationId": "xyz789",
"annotation": Annotation,
"errors": [ObjectNotFoundError]
}
}
}
answerFeedback
Description
Give Feedback about an answer provided by me.answers
Response
Returns an
AnswerFeedbackPayload
Arguments
| Name | Description |
|---|---|
input -
AnswerFeedbackInput!
|
Example
Query
mutation answerFeedback($input: AnswerFeedbackInput!) {
answerFeedback(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on UnconfiguredServiceError {
...UnconfiguredServiceErrorFragment
}
}
answer {
...AnswerFragment
}
}
}
Variables
{"input": AnswerFeedbackInput}
Response
{
"data": {
"answerFeedback": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"answer": Answer
}
}
}
answerResolve
Description
Mark an Answer as resolved and provide a message to the user
Response
Returns an
AnswerResolvePayload
Arguments
| Name | Description |
|---|---|
input -
AnswerResolveInput!
|
Example
Query
mutation answerResolve($input: AnswerResolveInput!) {
answerResolve(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on UnconfiguredServiceError {
...UnconfiguredServiceErrorFragment
}
}
answer {
...AnswerFragment
}
}
}
Variables
{"input": AnswerResolveInput}
Response
{
"data": {
"answerResolve": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"answer": Answer
}
}
}
appLauncherCreate
Description
Create a new AppLauncher object to be display for everybody or only list of team's users require InstanceActions.appLauncherEdit
Response
Returns an
AppLauncherCreatePayload
Arguments
| Name | Description |
|---|---|
input -
AppLauncherCreateInput!
|
Example
Query
mutation appLauncherCreate($input: AppLauncherCreateInput!) {
appLauncherCreate(input: $input) {
clientMutationId
edge {
...AppLauncherEdgeFragment
}
launcher {
...AppLauncherFragment
}
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": AppLauncherCreateInput}
Response
{
"data": {
"appLauncherCreate": {
"clientMutationId": "abc123",
"edge": AppLauncherEdge,
"launcher": AppLauncher,
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
appLauncherDelete
Description
Delete a single AppLauncher object. require InstanceActions.appLauncherEdit
Response
Returns an
AppLauncherDeletePayload
Arguments
| Name | Description |
|---|---|
input -
AppLauncherDeleteInput!
|
Example
Query
mutation appLauncherDelete($input: AppLauncherDeleteInput!) {
appLauncherDelete(input: $input) {
clientMutationId
deletedId
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": AppLauncherDeleteInput}
Response
{
"data": {
"appLauncherDelete": {
"clientMutationId": "xyz789",
"deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
appLauncherEdit
Description
Edit an AppLauncher object. require InstanceActions.appLauncherEdit
Response
Returns an
AppLauncherEditPayload
Arguments
| Name | Description |
|---|---|
input -
AppLauncherEditInput!
|
Example
Query
mutation appLauncherEdit($input: AppLauncherEditInput!) {
appLauncherEdit(input: $input) {
clientMutationId
launcher {
...AppLauncherFragment
}
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": AppLauncherEditInput}
Response
{
"data": {
"appLauncherEdit": {
"clientMutationId": "xyz789",
"launcher": AppLauncher,
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
appLauncherOrder
Description
Change the order in which the AppLauncher should be displayed to users. require InstanceActions.appLauncherOrder
Response
Returns an
AppLauncherOrderPayload
Arguments
| Name | Description |
|---|---|
input -
AppLauncherOrderInput!
|
Example
Query
mutation appLauncherOrder($input: AppLauncherOrderInput!) {
appLauncherOrder(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": AppLauncherOrderInput}
Response
{
"data": {
"appLauncherOrder": {
"clientMutationId": "abc123",
"instance": Instance,
"errors": [PermissionError]
}
}
}
assetPreview
Description
Get a preview of a given asset. Currently only CloudFile and CloudFolder are supported
Response
Returns an
AssetPreviewPayload
Arguments
| Name | Description |
|---|---|
input -
StoryAssetInput!
|
Example
Query
mutation assetPreview($input: StoryAssetInput!) {
assetPreview(input: $input) {
asset {
...AssetFragment
}
clientMutationId
}
}
Variables
{"input": StoryAssetInput}
Response
{
"data": {
"assetPreview": {
"asset": Asset,
"clientMutationId": "abc123"
}
}
}
checkPassword
Description
Verify if the password is correct with a registration token
Response
Returns a
CheckPasswordPayload
Arguments
| Name | Description |
|---|---|
input -
CheckPasswordInput!
|
Example
Query
mutation checkPassword($input: CheckPasswordInput!) {
checkPassword(input: $input) {
clientMutationId
errors {
... on InvalidInputError {
...InvalidInputErrorFragment
}
... on InvalidPasswordError {
...InvalidPasswordErrorFragment
}
}
success
}
}
Variables
{"input": CheckPasswordInput}
Response
{
"data": {
"checkPassword": {
"clientMutationId": "xyz789",
"errors": [InvalidInputError],
"success": false
}
}
}
commentDelete
Description
Delete a comment. requires CommentActions.delete
Response
Returns a
CommentDeletePayload
Arguments
| Name | Description |
|---|---|
input -
CommentDeleteInput!
|
Example
Query
mutation commentDelete($input: CommentDeleteInput!) {
commentDelete(input: $input) {
clientMutationId
id
deletedId
parent {
...StoryFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": CommentDeleteInput}
Response
{
"data": {
"commentDelete": {
"clientMutationId": "xyz789",
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"parent": Story,
"errors": [ObjectNotFoundError]
}
}
}
commentEdit
Description
Edit a comment. requires CommentActions.edit
Response
Returns a
CommentEditPayload
Arguments
| Name | Description |
|---|---|
input -
CommentEditInput!
|
Example
Query
mutation commentEdit($input: CommentEditInput!) {
commentEdit(input: $input) {
clientMutationId
comment {
...CommentFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": CommentEditInput}
Response
{
"data": {
"commentEdit": {
"clientMutationId": "xyz789",
"comment": Comment,
"errors": [ObjectNotFoundError]
}
}
}
commentLike
Description
Like or unlike a specific comment
Response
Returns a
CommentLikePayload
Arguments
| Name | Description |
|---|---|
input -
CommentLikeInput!
|
Example
Query
mutation commentLike($input: CommentLikeInput!) {
commentLike(input: $input) {
clientMutationId
comment {
...CommentFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
}
}
Variables
{"input": CommentLikeInput}
Response
{
"data": {
"commentLike": {
"clientMutationId": "abc123",
"comment": Comment,
"errors": [ObjectNotFoundError]
}
}
}
commentPost
Description
Post a comment on a content Comment might be posted from different sources CommentSource and can contain assets
Response
Returns a
CommentPostPayload
Arguments
| Name | Description |
|---|---|
input -
CommentPostInput!
|
Example
Query
mutation commentPost($input: CommentPostInput!) {
commentPost(input: $input) {
clientMutationId
commentEdge {
...CommentEdgeFragment
}
parent {
...StoryFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": CommentPostInput}
Response
{
"data": {
"commentPost": {
"clientMutationId": "abc123",
"commentEdge": CommentEdge,
"parent": Story,
"errors": [ObjectNotFoundError]
}
}
}
connectedAppCreate
Description
Create a new ConnectedApp
Response
Returns a
ConnectedAppCreatePayload
Arguments
| Name | Description |
|---|---|
input -
ConnectedAppCreateInput!
|
Example
Query
mutation connectedAppCreate($input: ConnectedAppCreateInput!) {
connectedAppCreate(input: $input) {
clientMutationId
connectedApp {
...ConnectedAppFragment
}
edge {
...ConnectedAppEdgeFragment
}
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": ConnectedAppCreateInput}
Response
{
"data": {
"connectedAppCreate": {
"clientMutationId": "abc123",
"connectedApp": ConnectedApp,
"edge": ConnectedAppEdge,
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
connectedAppDelete
Description
Delete a single ConnectedApp object.
Response
Returns a
ConnectedAppDeletePayload
Arguments
| Name | Description |
|---|---|
input -
ConnectedAppDeleteInput!
|
Example
Query
mutation connectedAppDelete($input: ConnectedAppDeleteInput!) {
connectedAppDelete(input: $input) {
clientMutationId
deletedId
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": ConnectedAppDeleteInput}
Response
{
"data": {
"connectedAppDelete": {
"clientMutationId": "xyz789",
"deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
connectedAppEdit
Description
Edit an ConnectedApp object.
Response
Returns a
ConnectedAppEditPayload
Arguments
| Name | Description |
|---|---|
input -
ConnectedAppEditInput!
|
Example
Query
mutation connectedAppEdit($input: ConnectedAppEditInput!) {
connectedAppEdit(input: $input) {
clientMutationId
connectedApp {
...ConnectedAppFragment
}
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": ConnectedAppEditInput}
Response
{
"data": {
"connectedAppEdit": {
"clientMutationId": "abc123",
"connectedApp": ConnectedApp,
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
contentLike
Description
Toggle Like status of a Story
Response
Returns a
ContentLikePayload
Arguments
| Name | Description |
|---|---|
input -
ContentLikeInput!
|
Example
Query
mutation contentLike($input: ContentLikeInput!) {
contentLike(input: $input) {
clientMutationId
content {
...NodeFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
}
}
Variables
{"input": ContentLikeInput}
Response
{
"data": {
"contentLike": {
"clientMutationId": "abc123",
"content": Node,
"errors": [ObjectNotFoundError]
}
}
}
disableStandardContent
Description
Set the disabled standard content items within ['story file link event'] Standard content are hardcoded "fake schemas" in the front-end
Response
Returns a
DisableStandardContentPayload
Arguments
| Name | Description |
|---|---|
input -
DisableStandardContentInput!
|
Example
Query
mutation disableStandardContent($input: DisableStandardContentInput!) {
disableStandardContent(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": DisableStandardContentInput}
Response
{
"data": {
"disableStandardContent": {
"clientMutationId": "abc123",
"instance": Instance,
"errors": [PermissionError]
}
}
}
emailPipelineCreate
Description
Create a new EmailPipeline object to ingest content in the platform require InstanceActions.emailPipelineEdit
Response
Returns an
EmailPipelineCreatePayload
Arguments
| Name | Description |
|---|---|
input -
EmailPipelineCreateInput!
|
Example
Query
mutation emailPipelineCreate($input: EmailPipelineCreateInput!) {
emailPipelineCreate(input: $input) {
clientMutationId
pipeline {
...EmailPipelineFragment
}
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectAlreadyExistsError {
...ObjectAlreadyExistsErrorFragment
}
... on InvalidFormatError {
...InvalidFormatErrorFragment
}
}
}
}
Variables
{"input": EmailPipelineCreateInput}
Response
{
"data": {
"emailPipelineCreate": {
"clientMutationId": "abc123",
"pipeline": EmailPipeline,
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
emailPipelineDelete
Description
Delete a single EmailPipeline object. require InstanceActions.emailPipelineEdit
Response
Returns an
EmailPipelineDeletePayload
Arguments
| Name | Description |
|---|---|
input -
EmailPipelineDeleteInput!
|
Example
Query
mutation emailPipelineDelete($input: EmailPipelineDeleteInput!) {
emailPipelineDelete(input: $input) {
clientMutationId
deletedId
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": EmailPipelineDeleteInput}
Response
{
"data": {
"emailPipelineDelete": {
"clientMutationId": "abc123",
"deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
emailPipelineEdit
Description
Edit an EmailPipeline object. require InstanceActions.emailPipelineEdit
Response
Returns an
EmailPipelineEditPayload
Arguments
| Name | Description |
|---|---|
input -
EmailPipelineEditInput!
|
Example
Query
mutation emailPipelineEdit($input: EmailPipelineEditInput!) {
emailPipelineEdit(input: $input) {
clientMutationId
pipeline {
...EmailPipelineFragment
}
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectAlreadyExistsError {
...ObjectAlreadyExistsErrorFragment
}
... on InvalidFormatError {
...InvalidFormatErrorFragment
}
}
}
}
Variables
{"input": EmailPipelineEditInput}
Response
{
"data": {
"emailPipelineEdit": {
"clientMutationId": "abc123",
"pipeline": EmailPipeline,
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
eventInvite
Description
Invite user to an Story with event defined requires StoryActions.edit
Response
Returns an
EventInvitePayload
Arguments
| Name | Description |
|---|---|
input -
EventInviteInput!
|
Example
Query
mutation eventInvite($input: EventInviteInput!) {
eventInvite(input: $input) {
clientMutationId
story {
...StoryFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
}
}
Variables
{"input": EventInviteInput}
Response
{
"data": {
"eventInvite": {
"clientMutationId": "xyz789",
"story": Story,
"errors": [PermissionError]
}
}
}
eventRespond
Description
Respond to an event Invitation (RSVP)
Response
Returns an
EventRespondPayload
Arguments
| Name | Description |
|---|---|
input -
EventRespondInput!
|
Example
Query
mutation eventRespond($input: EventRespondInput!) {
eventRespond(input: $input) {
clientMutationId
story {
...StoryFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
}
}
Variables
{"input": EventRespondInput}
Response
{
"data": {
"eventRespond": {
"clientMutationId": "xyz789",
"story": Story,
"errors": [PermissionError]
}
}
}
facetCreate
Description
Create a facet (or category of tags)
Response
Returns a
FacetCreatePayload
Arguments
| Name | Description |
|---|---|
input -
FacetCreateInput!
|
Example
Query
mutation facetCreate($input: FacetCreateInput!) {
facetCreate(input: $input) {
clientMutationId
facet {
...FacetFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
}
}
Variables
{"input": FacetCreateInput}
Response
{
"data": {
"facetCreate": {
"clientMutationId": "abc123",
"facet": Facet,
"errors": [PermissionError]
}
}
}
folderAddTag
Description
Add a tag on all the items in a Folder
Response
Returns a
FolderAddTagPayload
Arguments
| Name | Description |
|---|---|
input -
FolderAddTagInput!
|
Example
Query
mutation folderAddTag($input: FolderAddTagInput!) {
folderAddTag(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": FolderAddTagInput}
Response
{
"data": {
"folderAddTag": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError]
}
}
}
folderDelete
Description
Delete a given Folder
Response
Returns a
FolderDeletePayload
Arguments
| Name | Description |
|---|---|
input -
FolderDeleteInput!
|
Example
Query
mutation folderDelete($input: FolderDeleteInput!) {
folderDelete(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on RootFolderRemoveError {
...RootFolderRemoveErrorFragment
}
}
}
}
Variables
{"input": FolderDeleteInput}
Response
{
"data": {
"folderDelete": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError]
}
}
}
folderMove
Description
Move a contents of a folder to another space/owner
Response
Returns a
FolderMovePayload
Arguments
| Name | Description |
|---|---|
input -
FolderMoveInput!
|
Example
Query
mutation folderMove($input: FolderMoveInput!) {
folderMove(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on RootFolderRemoveError {
...RootFolderRemoveErrorFragment
}
}
}
}
Variables
{"input": FolderMoveInput}
Response
{
"data": {
"folderMove": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError]
}
}
}
hashtagCreate
Description
Create a tag not linked to a category
Response
Returns a
HashtagCreatePayload
Arguments
| Name | Description |
|---|---|
input -
HashtagCreateInput!
|
Example
Query
mutation hashtagCreate($input: HashtagCreateInput!) {
hashtagCreate(input: $input) {
clientMutationId
hashtag {
...HashtagFragment
}
me {
...MeFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": HashtagCreateInput}
Response
{
"data": {
"hashtagCreate": {
"clientMutationId": "abc123",
"hashtag": Hashtag,
"me": Me,
"errors": [PermissionError]
}
}
}
instanceActivate
Response
Returns an
InstanceActivatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceActivateInput!
|
Example
Query
mutation instanceActivate($input: InstanceActivateInput!) {
instanceActivate(input: $input) {
clientMutationId
errors {
... on InvalidInputError {
...InvalidInputErrorFragment
}
... on InvalidPlanError {
...InvalidPlanErrorFragment
}
... on InvalidPasswordError {
...InvalidPasswordErrorFragment
}
}
instance {
...InstanceFragment
}
user {
...UserFragment
}
}
}
Variables
{"input": InstanceActivateInput}
Response
{
"data": {
"instanceActivate": {
"clientMutationId": "xyz789",
"errors": [InvalidInputError],
"instance": Instance,
"user": User
}
}
}
instanceCancelSubscription
Response
Returns an
InstanceCancelSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input -
InstanceCancelSubscriptionInput!
|
Example
Query
mutation instanceCancelSubscription($input: InstanceCancelSubscriptionInput!) {
instanceCancelSubscription(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": InstanceCancelSubscriptionInput}
Response
{
"data": {
"instanceCancelSubscription": {
"clientMutationId": "abc123",
"instance": Instance,
"errors": [PermissionError]
}
}
}
instanceCompleteOnboadingStep
Description
Mark a step as completed (or skipped)
Response
Returns an
InstanceCompleteOnboadingStepPayload
Arguments
| Name | Description |
|---|---|
input -
InstanceCompleteOnboadingStepInput!
|
Example
Query
mutation instanceCompleteOnboadingStep($input: InstanceCompleteOnboadingStepInput!) {
instanceCompleteOnboadingStep(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": InstanceCompleteOnboadingStepInput}
Response
{
"data": {
"instanceCompleteOnboadingStep": {
"clientMutationId": "abc123",
"instance": Instance,
"errors": [PermissionError]
}
}
}
instanceContactsUpdate
Response
Returns an
InstanceContactsUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceContactsUpdateInput!
|
Example
Query
mutation instanceContactsUpdate($input: InstanceContactsUpdateInput!) {
instanceContactsUpdate(input: $input) {
clientMutationId
contacts {
...InstanceContactsFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": InstanceContactsUpdateInput}
Response
{
"data": {
"instanceContactsUpdate": {
"clientMutationId": "xyz789",
"contacts": InstanceContacts,
"errors": [PermissionError]
}
}
}
instanceDelete
Response
Returns an
InstanceDeletePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceDeleteInput!
|
Example
Query
mutation instanceDelete($input: InstanceDeleteInput!) {
instanceDelete(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": InstanceDeleteInput}
Response
{
"data": {
"instanceDelete": {
"clientMutationId": "abc123",
"errors": [PermissionError]
}
}
}
instanceDisclaimerSetup
Description
Setup instance disclaimer options
Response
Returns an
InstanceDisclaimerSetupPayload
Arguments
| Name | Description |
|---|---|
input -
InstanceDisclaimerSetupInput!
|
Example
Query
mutation instanceDisclaimerSetup($input: InstanceDisclaimerSetupInput!) {
instanceDisclaimerSetup(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
instanceAuth {
...InstanceAuthenticationFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": InstanceDisclaimerSetupInput}
Response
{
"data": {
"instanceDisclaimerSetup": {
"clientMutationId": "xyz789",
"instance": Instance,
"instanceAuth": InstanceAuthentication,
"errors": [PermissionError]
}
}
}
instanceExport
Description
Launch an export of the instance internal use
Response
Returns an
InstanceExportPayload
Arguments
| Name | Description |
|---|---|
input -
InstanceExportInput!
|
Example
Query
mutation instanceExport($input: InstanceExportInput!) {
instanceExport(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceExportInput}
Response
{
"data": {
"instanceExport": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"instance": Instance
}
}
}
instanceFinishProvisionning
Description
Reset the steps done/skipped from the onboarding used mostly to reset the onboarding after the provisioning that completed severall steps
Response
Returns an
InstanceFinishProvisionningPayload
Arguments
| Name | Description |
|---|---|
input -
InstanceFinishProvisionningInput!
|
Example
Query
mutation instanceFinishProvisionning($input: InstanceFinishProvisionningInput!) {
instanceFinishProvisionning(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": InstanceFinishProvisionningInput}
Response
{
"data": {
"instanceFinishProvisionning": {
"clientMutationId": "xyz789",
"instance": Instance,
"errors": [PermissionError]
}
}
}
instanceGoogleAnalyticsUpdate
Response
Returns an
InstanceGoogleAnalyticsUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceGoogleAnalyticsUpdateInput!
|
Example
Query
mutation instanceGoogleAnalyticsUpdate($input: InstanceGoogleAnalyticsUpdateInput!) {
instanceGoogleAnalyticsUpdate(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": InstanceGoogleAnalyticsUpdateInput}
Response
{
"data": {
"instanceGoogleAnalyticsUpdate": {
"clientMutationId": "xyz789",
"instance": Instance,
"errors": [PermissionError]
}
}
}
instanceGoogleDriveUpdate
Response
Returns an
InstanceGoogleDriveUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceGoogleDriveUpdateInput!
|
Example
Query
mutation instanceGoogleDriveUpdate($input: InstanceGoogleDriveUpdateInput!) {
instanceGoogleDriveUpdate(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceGoogleDriveUpdateInput}
Response
{
"data": {
"instanceGoogleDriveUpdate": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"instance": Instance
}
}
}
instanceInvoiceUpdate
Description
Updates the invoice's reference with the newly given reference. Passing a None value will erase its value.
Response
Returns an
InstanceInvoiceUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceInvoiceUpdateInput!
|
Example
Query
mutation instanceInvoiceUpdate($input: InstanceInvoiceUpdateInput!) {
instanceInvoiceUpdate(input: $input) {
clientMutationId
invoice {
...InstanceInvoiceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": InstanceInvoiceUpdateInput}
Response
{
"data": {
"instanceInvoiceUpdate": {
"clientMutationId": "xyz789",
"invoice": InstanceInvoice,
"errors": [PermissionError]
}
}
}
instanceLabFlagUpdate
Description
Toggles a Lab flag by name, after verifying that the flag is indeed admin-flippable
Response
Returns an
InstanceLabFlagUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceLabFlagUpdateInput!
|
Example
Query
mutation instanceLabFlagUpdate($input: InstanceLabFlagUpdateInput!) {
instanceLabFlagUpdate(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": InstanceLabFlagUpdateInput}
Response
{
"data": {
"instanceLabFlagUpdate": {
"clientMutationId": "abc123",
"instance": Instance,
"errors": [PermissionError]
}
}
}
instanceMicrosoftTeamsUpdate
Description
Sets the value of the Microsoft Teams feature flag Setting this to False will disable all outbound Teams API calls
Response
Returns an
InstanceMicrosoftTeamsUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceMicrosoftTeamsUpdateInput!
|
Example
Query
mutation instanceMicrosoftTeamsUpdate($input: InstanceMicrosoftTeamsUpdateInput!) {
instanceMicrosoftTeamsUpdate(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceMicrosoftTeamsUpdateInput}
Response
{
"data": {
"instanceMicrosoftTeamsUpdate": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"instance": Instance
}
}
}
instanceMobileAppDescriptionsUpdate
Description
Update the mobile app descriptions
Response
Returns an
InstanceMobileAppDescriptionsUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceMobileAppDescriptionsUpdateInput!
|
Example
Query
mutation instanceMobileAppDescriptionsUpdate($input: InstanceMobileAppDescriptionsUpdateInput!) {
instanceMobileAppDescriptionsUpdate(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": InstanceMobileAppDescriptionsUpdateInput}
Response
{
"data": {
"instanceMobileAppDescriptionsUpdate": {
"clientMutationId": "xyz789",
"instance": Instance,
"errors": [PermissionError]
}
}
}
instanceOfficeOnlineUpdate
Description
Enable Office 365 online Integration for end users You can then preview office files as well as edit them directly from the browser
Response
Returns an
InstanceOfficeOnlineUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceOfficeOnlineUpdateInput!
|
Example
Query
mutation instanceOfficeOnlineUpdate($input: InstanceOfficeOnlineUpdateInput!) {
instanceOfficeOnlineUpdate(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on LimitsViolationError {
...LimitsViolationErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceOfficeOnlineUpdateInput}
Response
{
"data": {
"instanceOfficeOnlineUpdate": {
"clientMutationId": "abc123",
"errors": [PermissionError],
"instance": Instance
}
}
}
instanceOneDriveUpdate
Description
Enable Onedrive Integration for end users You can then add Onedrive blocks in stories as well as importing files from admin
Response
Returns an
InstanceOneDriveUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceOneDriveUpdateInput!
|
Example
Query
mutation instanceOneDriveUpdate($input: InstanceOneDriveUpdateInput!) {
instanceOneDriveUpdate(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceOneDriveUpdateInput}
Response
{
"data": {
"instanceOneDriveUpdate": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"instance": Instance
}
}
}
instanceScimConfigUpdate
Description
Change instance SCIM configuration
Response
Returns an
InstanceScimConfigUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceScimConfigUpdateInput!
|
Example
Query
mutation instanceScimConfigUpdate($input: InstanceScimConfigUpdateInput!) {
instanceScimConfigUpdate(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on LimitsViolationError {
...LimitsViolationErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceScimConfigUpdateInput}
Response
{
"data": {
"instanceScimConfigUpdate": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"instance": Instance
}
}
}
instanceSettingsUpdate
Description
Change instance Settings, security, ... Requires me.actions.admin
Response
Returns an
InstanceSettingsUpdatePayload!
Arguments
| Name | Description |
|---|---|
input -
InstanceSettingsUpdateInput!
|
Example
Query
mutation instanceSettingsUpdate($input: InstanceSettingsUpdateInput!) {
instanceSettingsUpdate(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on LimitsViolationError {
...LimitsViolationErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceSettingsUpdateInput}
Response
{
"data": {
"instanceSettingsUpdate": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"instance": Instance
}
}
}
instanceSlackUpdate
Description
Sets the value of the Slack feature flag Setting this to False will disable all outbound Slack API calls
Response
Returns an
InstanceSlackUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceSlackUpdateInput!
|
Example
Query
mutation instanceSlackUpdate($input: InstanceSlackUpdateInput!) {
instanceSlackUpdate(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceSlackUpdateInput}
Response
{
"data": {
"instanceSlackUpdate": {
"clientMutationId": "abc123",
"errors": [PermissionError],
"instance": Instance
}
}
}
instanceSsoConfigUpdate
Description
Change instance SSO configuration
Response
Returns an
InstanceSsoConfigUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceSsoConfigUpdateInput!
|
Example
Query
mutation instanceSsoConfigUpdate($input: InstanceSsoConfigUpdateInput!) {
instanceSsoConfigUpdate(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on LimitsViolationError {
...LimitsViolationErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
... on InvalidFormatError {
...InvalidFormatErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceSsoConfigUpdateInput}
Response
{
"data": {
"instanceSsoConfigUpdate": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"instance": Instance
}
}
}
instanceThemeUpdate
Response
Returns an
InstanceThemeUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceThemeUpdateInput!
|
Example
Query
mutation instanceThemeUpdate($input: InstanceThemeUpdateInput!) {
instanceThemeUpdate(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceThemeUpdateInput}
Response
{
"data": {
"instanceThemeUpdate": {
"clientMutationId": "abc123",
"errors": [PermissionError],
"instance": Instance
}
}
}
instanceUpdateSubscription
Response
Returns an
InstanceUpdateSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input -
InstanceUpdateSubscriptionInput!
|
Example
Query
mutation instanceUpdateSubscription($input: InstanceUpdateSubscriptionInput!) {
instanceUpdateSubscription(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidPlanError {
...InvalidPlanErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
... on InvalidPlanLimitsError {
...InvalidPlanLimitsErrorFragment
}
... on SubscriptionUpdateError {
...SubscriptionUpdateErrorFragment
}
}
}
}
Variables
{"input": InstanceUpdateSubscriptionInput}
Response
{
"data": {
"instanceUpdateSubscription": {
"clientMutationId": "xyz789",
"instance": Instance,
"errors": [PermissionError]
}
}
}
instanceWorkplaceUpdate
Response
Returns an
InstanceWorkplaceUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
InstanceWorkplaceUpdateInput!
|
Example
Query
mutation instanceWorkplaceUpdate($input: InstanceWorkplaceUpdateInput!) {
instanceWorkplaceUpdate(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": InstanceWorkplaceUpdateInput}
Response
{
"data": {
"instanceWorkplaceUpdate": {
"clientMutationId": "abc123",
"errors": [PermissionError],
"instance": Instance
}
}
}
meActivateTwoFactor
Description
Verify QrCode and if correct, persist and activate the 2FA for this user. verificationCode Should be a 6 number string it will be verified again the latest qrcode seen (see MePreferences.twoFactorCodeUrl)
Response
Returns a
MeActivateTwoFactorPayload
Arguments
| Name | Description |
|---|---|
input -
MeActivateTwoFactorInput!
|
Example
Query
mutation meActivateTwoFactor($input: MeActivateTwoFactorInput!) {
meActivateTwoFactor(input: $input) {
clientMutationId
errors {
... on InvalidPasswordError {
...InvalidPasswordErrorFragment
}
}
me {
...MeFragment
}
}
}
Variables
{"input": MeActivateTwoFactorInput}
Response
{
"data": {
"meActivateTwoFactor": {
"clientMutationId": "abc123",
"errors": [InvalidPasswordError],
"me": Me
}
}
}
meBookmarksClear
Response
Returns a
MeBookmarksClearPayload
Arguments
| Name | Description |
|---|---|
input -
MeBookmarksClearInput!
|
Example
Query
mutation meBookmarksClear($input: MeBookmarksClearInput!) {
meBookmarksClear(input: $input) {
clientMutationId
me {
...MeFragment
}
}
}
Variables
{"input": MeBookmarksClearInput}
Response
{
"data": {
"meBookmarksClear": {
"clientMutationId": "abc123",
"me": Me
}
}
}
meDeviceTokenPublish
Description
Will send a PUSH notification to the registered device. This is used only for debugging purposes
Response
Returns a
MeDeviceTokenPublishPayload
Arguments
| Name | Description |
|---|---|
input -
MeDeviceTokenPublishInput!
|
Example
Query
mutation meDeviceTokenPublish($input: MeDeviceTokenPublishInput!) {
meDeviceTokenPublish(input: $input) {
clientMutationId
deviceToken {
...MeDeviceTokenFragment
}
sent
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
}
}
Variables
{"input": MeDeviceTokenPublishInput}
Response
{
"data": {
"meDeviceTokenPublish": {
"clientMutationId": "abc123",
"deviceToken": MeDeviceToken,
"sent": true,
"errors": [ObjectNotFoundError]
}
}
}
meDeviceTokenRegister
Response
Returns a
MeDeviceTokenRegisterPayload
Arguments
| Name | Description |
|---|---|
input -
MeDeviceTokenRegisterInput!
|
Example
Query
mutation meDeviceTokenRegister($input: MeDeviceTokenRegisterInput!) {
meDeviceTokenRegister(input: $input) {
clientMutationId
deviceToken {
...MeDeviceTokenFragment
}
}
}
Variables
{"input": MeDeviceTokenRegisterInput}
Response
{
"data": {
"meDeviceTokenRegister": {
"clientMutationId": "abc123",
"deviceToken": MeDeviceToken
}
}
}
meDeviceTokenUnregister
Response
Returns a
MeDeviceTokenUnregisterPayload
Arguments
| Name | Description |
|---|---|
input -
MeDeviceTokenUnregisterInput!
|
Example
Query
mutation meDeviceTokenUnregister($input: MeDeviceTokenUnregisterInput!) {
meDeviceTokenUnregister(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
me {
...MeFragment
}
}
}
Variables
{"input": MeDeviceTokenUnregisterInput}
Response
{
"data": {
"meDeviceTokenUnregister": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"me": Me
}
}
}
meDisclaimerAccept
Response
Returns a
MeDisclaimerAcceptPayload
Arguments
| Name | Description |
|---|---|
input -
MeDisclaimerAcceptInput!
|
Example
Query
mutation meDisclaimerAccept($input: MeDisclaimerAcceptInput!) {
meDisclaimerAccept(input: $input) {
clientMutationId
me {
...MeFragment
}
}
}
Variables
{"input": MeDisclaimerAcceptInput}
Response
{
"data": {
"meDisclaimerAccept": {
"clientMutationId": "xyz789",
"me": Me
}
}
}
meNotificationsPreferences
Description
Update notification preferences for the current user
Response
Returns a
MeNotificationsPreferencesPayload
Arguments
| Name | Description |
|---|---|
input -
MeNotificationsPreferencesInput!
|
Example
Query
mutation meNotificationsPreferences($input: MeNotificationsPreferencesInput!) {
meNotificationsPreferences(input: $input) {
clientMutationId
me {
...MeFragment
}
}
}
Variables
{"input": MeNotificationsPreferencesInput}
Response
{
"data": {
"meNotificationsPreferences": {
"clientMutationId": "xyz789",
"me": Me
}
}
}
mePasswordChange
Response
Returns a
MePasswordChangePayload
Arguments
| Name | Description |
|---|---|
input -
MePasswordChangeInput!
|
Example
Query
mutation mePasswordChange($input: MePasswordChangeInput!) {
mePasswordChange(input: $input) {
clientMutationId
me {
...MeFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidPasswordError {
...InvalidPasswordErrorFragment
}
}
}
}
Variables
{"input": MePasswordChangeInput}
Response
{
"data": {
"mePasswordChange": {
"clientMutationId": "abc123",
"me": Me,
"errors": [PermissionError]
}
}
}
mePreferencesUpdate
Response
Returns a
MePreferencesUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
MePreferencesUpdateInput!
|
Example
Query
mutation mePreferencesUpdate($input: MePreferencesUpdateInput!) {
mePreferencesUpdate(input: $input) {
clientMutationId
me {
...MeFragment
}
errors {
... on EmailAlreadyExistsError {
...EmailAlreadyExistsErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": MePreferencesUpdateInput}
Response
{
"data": {
"mePreferencesUpdate": {
"clientMutationId": "xyz789",
"me": Me,
"errors": [EmailAlreadyExistsError]
}
}
}
mePresenceUpdate
Description
Update user's presence status on a given device
Response
Returns a
MePresenceUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
MePresenceUpdateInput!
|
Example
Query
mutation mePresenceUpdate($input: MePresenceUpdateInput!) {
mePresenceUpdate(input: $input) {
clientMutationId
me {
...MeFragment
}
}
}
Variables
{"input": MePresenceUpdateInput}
Response
{
"data": {
"mePresenceUpdate": {
"clientMutationId": "xyz789",
"me": Me
}
}
}
meProfileSetupComplete
Response
Returns a
MeProfileSetupCompletePayload
Arguments
| Name | Description |
|---|---|
input -
MeProfileSetupCompleteInput!
|
Example
Query
mutation meProfileSetupComplete($input: MeProfileSetupCompleteInput!) {
meProfileSetupComplete(input: $input) {
clientMutationId
me {
...MeFragment
}
}
}
Variables
{"input": MeProfileSetupCompleteInput}
Response
{
"data": {
"meProfileSetupComplete": {
"clientMutationId": "xyz789",
"me": Me
}
}
}
meRemoveTwoFactor
Description
Remove a two factor token for the current user. You'll need to pass current 2fa verificationCode, and current Password to make it work. Note: you can't remove the 2fa if it's mandatory on the platform, but you can meActivateTwoFactor again
Response
Returns a
MeRemoveTwoFactorPayload
Arguments
| Name | Description |
|---|---|
input -
MeRemoveTwoFactorInput!
|
Example
Query
mutation meRemoveTwoFactor($input: MeRemoveTwoFactorInput!) {
meRemoveTwoFactor(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidPasswordError {
...InvalidPasswordErrorFragment
}
}
me {
...MeFragment
}
}
}
Variables
{"input": MeRemoveTwoFactorInput}
Response
{
"data": {
"meRemoveTwoFactor": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"me": Me
}
}
}
meServiceReset
Description
Reset the token of a given service
Response
Returns a
MeServiceResetPayload
Arguments
| Name | Description |
|---|---|
input -
MeServiceResetInput!
|
Example
Query
mutation meServiceReset($input: MeServiceResetInput!) {
meServiceReset(input: $input) {
clientMutationId
me {
...MeFragment
}
}
}
Variables
{"input": MeServiceResetInput}
Response
{
"data": {
"meServiceReset": {
"clientMutationId": "xyz789",
"me": Me
}
}
}
meServiceToken
Description
Obtain an Access token or refresh one for a given integration
Response
Returns a
MeServiceTokenPayload
Arguments
| Name | Description |
|---|---|
input -
MeServiceTokenInput!
|
Example
Query
mutation meServiceToken($input: MeServiceTokenInput!) {
meServiceToken(input: $input) {
accessToken
clientMutationId
expiresIn
errors {
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": MeServiceTokenInput}
Response
{
"data": {
"meServiceToken": {
"accessToken": "abc123",
"clientMutationId": "abc123",
"expiresIn": 987,
"errors": [InvalidInputError]
}
}
}
meTokenReset
Description
Reset or Remove a token for a given service
Response
Returns a
MeTokenResetPayload
Arguments
| Name | Description |
|---|---|
input -
MeTokenResetInput!
|
Example
Query
mutation meTokenReset($input: MeTokenResetInput!) {
meTokenReset(input: $input) {
clientMutationId
me {
...MeFragment
}
}
}
Variables
{"input": MeTokenResetInput}
Response
{
"data": {
"meTokenReset": {
"clientMutationId": "xyz789",
"me": Me
}
}
}
microsoftTeamsActivitiesConfigUpdate
Description
Updates the activities for which a message should be pushed to teams
Response
Arguments
| Name | Description |
|---|---|
input -
MicrosoftTeamsActivitiesConfigUpdateInput!
|
Example
Query
mutation microsoftTeamsActivitiesConfigUpdate($input: MicrosoftTeamsActivitiesConfigUpdateInput!) {
microsoftTeamsActivitiesConfigUpdate(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on UnconfiguredServiceError {
...UnconfiguredServiceErrorFragment
}
}
}
}
Variables
{"input": MicrosoftTeamsActivitiesConfigUpdateInput}
Response
{
"data": {
"microsoftTeamsActivitiesConfigUpdate": {
"clientMutationId": "xyz789",
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
microsoftTeamsSpacesToChannelRemove
Description
Removes the "Elium space to Microsoft Teams channel mapping" (SpacesToChannelItem) if it exists
Response
Arguments
| Name | Description |
|---|---|
input -
MicrosoftTeamsSpacesToChannelRemoveInput!
|
Example
Query
mutation microsoftTeamsSpacesToChannelRemove($input: MicrosoftTeamsSpacesToChannelRemoveInput!) {
microsoftTeamsSpacesToChannelRemove(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": MicrosoftTeamsSpacesToChannelRemoveInput}
Response
{
"data": {
"microsoftTeamsSpacesToChannelRemove": {
"clientMutationId": "xyz789",
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
microsoftTeamsSpacesToChannelUpdate
Description
Add a Mapping between a space and a Microsoft Teams channel
Activities in the space will trigger a notification in the team channel depndening on the configuration. See teamActivitiesConfigUpdate
Response
Arguments
| Name | Description |
|---|---|
input -
MicrosoftTeamsSpacesToChannelUpdateInput!
|
Example
Query
mutation microsoftTeamsSpacesToChannelUpdate($input: MicrosoftTeamsSpacesToChannelUpdateInput!) {
microsoftTeamsSpacesToChannelUpdate(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on UnconfiguredServiceError {
...UnconfiguredServiceErrorFragment
}
}
}
}
Variables
{"input": MicrosoftTeamsSpacesToChannelUpdateInput}
Response
{
"data": {
"microsoftTeamsSpacesToChannelUpdate": {
"clientMutationId": "abc123",
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
microsoftTeamsTabEmbed
Description
Embed an Elium tab as a Teams Website tab (that will only work in the Teams desktop app, not the web app)
Response
Returns a
MicrosoftTeamsTabEmbedPayload
Arguments
| Name | Description |
|---|---|
input -
MicrosoftTeamsTabEmbedInput!
|
Example
Query
mutation microsoftTeamsTabEmbed($input: MicrosoftTeamsTabEmbedInput!) {
microsoftTeamsTabEmbed(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on IntegrationError {
...IntegrationErrorFragment
}
... on UnconfiguredServiceError {
...UnconfiguredServiceErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": MicrosoftTeamsTabEmbedInput}
Response
{
"data": {
"microsoftTeamsTabEmbed": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"instance": Instance
}
}
}
notificationPin
Description
Pin/Unpin a notification
Response
Returns a
NotificationPinPayload
Arguments
| Name | Description |
|---|---|
input -
NotificationPinInput!
|
Example
Query
mutation notificationPin($input: NotificationPinInput!) {
notificationPin(input: $input) {
clientMutationId
me {
...MeFragment
}
notification {
...NotificationFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
}
}
Variables
{"input": NotificationPinInput}
Response
{
"data": {
"notificationPin": {
"clientMutationId": "abc123",
"me": Me,
"notification": Notification,
"errors": [ObjectNotFoundError]
}
}
}
notificationsRead
Response
Returns a
NotificationsReadPayload
Arguments
| Name | Description |
|---|---|
input -
NotificationsReadInput!
|
Example
Query
mutation notificationsRead($input: NotificationsReadInput!) {
notificationsRead(input: $input) {
clientMutationId
me {
...MeFragment
}
notifications {
...NotificationFragment
}
}
}
Variables
{"input": NotificationsReadInput}
Response
{
"data": {
"notificationsRead": {
"clientMutationId": "xyz789",
"me": Me,
"notifications": [Notification]
}
}
}
notificationsReadAll
Response
Returns a
NotificationsReadAllPayload
Arguments
| Name | Description |
|---|---|
input -
NotificationsReadAllInput!
|
Example
Query
mutation notificationsReadAll($input: NotificationsReadAllInput!) {
notificationsReadAll(input: $input) {
clientMutationId
}
}
Variables
{"input": NotificationsReadAllInput}
Response
{
"data": {
"notificationsReadAll": {
"clientMutationId": "xyz789"
}
}
}
notificationsSeenAll
Response
Returns a
NotificationsSeenAllPayload
Arguments
| Name | Description |
|---|---|
input -
NotificationsSeenAllInput!
|
Example
Query
mutation notificationsSeenAll($input: NotificationsSeenAllInput!) {
notificationsSeenAll(input: $input) {
clientMutationId
me {
...MeFragment
}
}
}
Variables
{"input": NotificationsSeenAllInput}
Response
{
"data": {
"notificationsSeenAll": {
"clientMutationId": "abc123",
"me": Me
}
}
}
notificationsUnread
Response
Returns a
NotificationsUnreadPayload
Arguments
| Name | Description |
|---|---|
input -
NotificationsUnreadInput!
|
Example
Query
mutation notificationsUnread($input: NotificationsUnreadInput!) {
notificationsUnread(input: $input) {
clientMutationId
me {
...MeFragment
}
notifications {
...NotificationFragment
}
}
}
Variables
{"input": NotificationsUnreadInput}
Response
{
"data": {
"notificationsUnread": {
"clientMutationId": "abc123",
"me": Me,
"notifications": [Notification]
}
}
}
organizationCreate
Description
Create a new organization with default settings
Response
Returns an
OrganizationCreatePayload
Arguments
| Name | Description |
|---|---|
input -
OrganizationCreateInput!
|
Example
Query
mutation organizationCreate($input: OrganizationCreateInput!) {
organizationCreate(input: $input) {
clientMutationId
organization {
...OrganizationFragment
}
errors {
... on InvalidFormatError {
...InvalidFormatErrorFragment
}
... on ObjectAlreadyExistsError {
...ObjectAlreadyExistsErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": OrganizationCreateInput}
Response
{
"data": {
"organizationCreate": {
"clientMutationId": "abc123",
"organization": Organization,
"errors": [InvalidFormatError]
}
}
}
organizationDelete
Description
Delete the specified organization
Response
Returns an
OrganizationDeletePayload
Arguments
| Name | Description |
|---|---|
input -
OrganizationDeleteInput!
|
Example
Query
mutation organizationDelete($input: OrganizationDeleteInput!) {
organizationDelete(input: $input) {
clientMutationId
deletedId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": OrganizationDeleteInput}
Response
{
"data": {
"organizationDelete": {
"clientMutationId": "abc123",
"deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"errors": [ObjectNotFoundError]
}
}
}
organizationUpdate
Description
Update the specified organization configuration and name
Response
Returns an
OrganizationUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
OrganizationUpdateInput!
|
Example
Query
mutation organizationUpdate($input: OrganizationUpdateInput!) {
organizationUpdate(input: $input) {
clientMutationId
organization {
...OrganizationFragment
}
errors {
... on InvalidFormatError {
...InvalidFormatErrorFragment
}
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": OrganizationUpdateInput}
Response
{
"data": {
"organizationUpdate": {
"clientMutationId": "xyz789",
"organization": Organization,
"errors": [InvalidFormatError]
}
}
}
schemaAttributeCreate
Response
Returns a
SchemaAttributeCreatePayload
Arguments
| Name | Description |
|---|---|
input -
SchemaAttributeCreateInput!
|
Example
Query
mutation schemaAttributeCreate($input: SchemaAttributeCreateInput!) {
schemaAttributeCreate(input: $input) {
attribute {
...SchemaAttributeFragment
}
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": SchemaAttributeCreateInput}
Response
{
"data": {
"schemaAttributeCreate": {
"attribute": SchemaAttribute,
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError]
}
}
}
schemaAttributeDelete
Description
Delete a Template field, remove the field from all content
Response
Returns a
SchemaAttributeDeletePayload
Arguments
| Name | Description |
|---|---|
input -
SchemaAttributeDeleteInput!
|
Example
Query
mutation schemaAttributeDelete($input: SchemaAttributeDeleteInput!) {
schemaAttributeDelete(input: $input) {
attribute {
... on SchemaSeparator {
...SchemaSeparatorFragment
}
... on SchemaAttribute {
...SchemaAttributeFragment
}
}
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": SchemaAttributeDeleteInput}
Response
{
"data": {
"schemaAttributeDelete": {
"attribute": SchemaSeparator,
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError]
}
}
}
schemaAttributeOptionCreate
Description
Create a new value to be used in a SchemaAttribute (applicable for attribute of TAG or TAG_LIST type => create a new tag in the facet)
Response
Returns a
SchemaAttributeOptionCreatePayload
Arguments
| Name | Description |
|---|---|
input -
SchemaAttributeOptionCreateInput!
|
Example
Query
mutation schemaAttributeOptionCreate($input: SchemaAttributeOptionCreateInput!) {
schemaAttributeOptionCreate(input: $input) {
clientMutationId
option {
...SchemaAttributeOptionFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": SchemaAttributeOptionCreateInput}
Response
{
"data": {
"schemaAttributeOptionCreate": {
"clientMutationId": "abc123",
"option": SchemaAttributeOption,
"errors": [ObjectNotFoundError]
}
}
}
schemaAttributeUpdate
Response
Returns a
SchemaAttributeUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
SchemaAttributeUpdateInput!
|
Example
Query
mutation schemaAttributeUpdate($input: SchemaAttributeUpdateInput!) {
schemaAttributeUpdate(input: $input) {
attribute {
... on SchemaSeparator {
...SchemaSeparatorFragment
}
... on SchemaAttribute {
...SchemaAttributeFragment
}
}
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": SchemaAttributeUpdateInput}
Response
{
"data": {
"schemaAttributeUpdate": {
"attribute": SchemaSeparator,
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError]
}
}
}
schemaSeparatorCreate
Response
Returns a
SchemaSeparatorCreatePayload
Arguments
| Name | Description |
|---|---|
input -
SchemaSeparatorCreateInput!
|
Example
Query
mutation schemaSeparatorCreate($input: SchemaSeparatorCreateInput!) {
schemaSeparatorCreate(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
separator {
...SchemaSeparatorFragment
}
}
}
Variables
{"input": SchemaSeparatorCreateInput}
Response
{
"data": {
"schemaSeparatorCreate": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError],
"separator": SchemaSeparator
}
}
}
searchFeedback
Description
Post a feedback about missing content in search results for your administrators.
Response
Returns a
SearchFeedbackPayload
Arguments
| Name | Description |
|---|---|
input -
SearchFeedbackInput!
|
Example
Query
mutation searchFeedback($input: SearchFeedbackInput!) {
searchFeedback(input: $input) {
clientMutationId
}
}
Variables
{"input": SearchFeedbackInput}
Response
{
"data": {
"searchFeedback": {
"clientMutationId": "abc123"
}
}
}
searchHistoryPost
Description
Insert search query history for later use like stats and improvements
Response
Returns a
SearchHistoryPostPayload
Arguments
| Name | Description |
|---|---|
input -
SearchHistoryPostInput!
|
Example
Query
mutation searchHistoryPost($input: SearchHistoryPostInput!) {
searchHistoryPost(input: $input) {
clientMutationId
}
}
Variables
{"input": SearchHistoryPostInput}
Response
{
"data": {
"searchHistoryPost": {
"clientMutationId": "abc123"
}
}
}
slackActivitiesConfigUpdate
Description
Updates the activities for which a message should be pushed to Slack
Response
Returns a
SlackActivitiesConfigUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
SlackActivitiesConfigUpdateInput!
|
Example
Query
mutation slackActivitiesConfigUpdate($input: SlackActivitiesConfigUpdateInput!) {
slackActivitiesConfigUpdate(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on UnconfiguredServiceError {
...UnconfiguredServiceErrorFragment
}
}
}
}
Variables
{"input": SlackActivitiesConfigUpdateInput}
Response
{
"data": {
"slackActivitiesConfigUpdate": {
"clientMutationId": "abc123",
"instance": Instance,
"errors": [PermissionError]
}
}
}
slackSpacesToChannelRemove
Description
Removes the "Elium space to Slack channel mapping" (SpacesToChannelItem) if it exists
Response
Returns a
SlackSpacesToChannelRemovePayload
Arguments
| Name | Description |
|---|---|
input -
SlackSpacesToChannelRemoveInput!
|
Example
Query
mutation slackSpacesToChannelRemove($input: SlackSpacesToChannelRemoveInput!) {
slackSpacesToChannelRemove(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on UnconfiguredServiceError {
...UnconfiguredServiceErrorFragment
}
}
}
}
Variables
{"input": SlackSpacesToChannelRemoveInput}
Response
{
"data": {
"slackSpacesToChannelRemove": {
"clientMutationId": "xyz789",
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
slackSpacesToChannelUpdate
Description
Add a Mapping between a space and a Slack channel.
Activities in the space will trigger a notification in the slack channel depndening on the configuration. See slackActivitiesConfigUpdate
Response
Returns a
SlackSpacesToChannelUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
SlackSpacesToChannelUpdateInput!
|
Example
Query
mutation slackSpacesToChannelUpdate($input: SlackSpacesToChannelUpdateInput!) {
slackSpacesToChannelUpdate(input: $input) {
clientMutationId
instance {
...InstanceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on UnconfiguredServiceError {
...UnconfiguredServiceErrorFragment
}
}
}
}
Variables
{"input": SlackSpacesToChannelUpdateInput}
Response
{
"data": {
"slackSpacesToChannelUpdate": {
"clientMutationId": "abc123",
"instance": Instance,
"errors": [ObjectNotFoundError]
}
}
}
smartFeedCreate
Description
Create a new SmartFeed require MeActions.smartFeedsManage to be able to create one.
Response
Returns a
SmartFeedCreatePayload
Arguments
| Name | Description |
|---|---|
input -
SmartFeedCreateInput!
|
Example
Query
mutation smartFeedCreate($input: SmartFeedCreateInput!) {
smartFeedCreate(input: $input) {
clientMutationId
errors {
... on InvalidInputError {
...InvalidInputErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
edge {
...SmartFeedEdgeFragment
}
smartFeed {
...SmartFeedFragment
}
}
}
Variables
{"input": SmartFeedCreateInput}
Response
{
"data": {
"smartFeedCreate": {
"clientMutationId": "abc123",
"errors": [InvalidInputError],
"edge": SmartFeedEdge,
"smartFeed": SmartFeed
}
}
}
smartFeedDelete
Description
Delete a SmartFeed require MeActions.smartFeedsManage to be able to remove it.
Response
Returns a
SmartFeedDeletePayload
Arguments
| Name | Description |
|---|---|
input -
SmartFeedDeleteInput!
|
Example
Query
mutation smartFeedDelete($input: SmartFeedDeleteInput!) {
smartFeedDelete(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
deletedId
instance {
...InstanceFragment
}
}
}
Variables
{"input": SmartFeedDeleteInput}
Response
{
"data": {
"smartFeedDelete": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"instance": Instance
}
}
}
smartFeedOrder
Description
Order the list of SmartFeed require MeActions.smartFeedsManage
Response
Returns a
SmartFeedOrderPayload
Arguments
| Name | Description |
|---|---|
input -
SmartFeedOrderInput!
|
Example
Query
mutation smartFeedOrder($input: SmartFeedOrderInput!) {
smartFeedOrder(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
instance {
...InstanceFragment
}
}
}
Variables
{"input": SmartFeedOrderInput}
Response
{
"data": {
"smartFeedOrder": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"instance": Instance
}
}
}
smartFeedUpdate
Description
Update a given SmartFeed require MeActions.smartFeedsManage to be able to edit one.
Response
Returns a
SmartFeedUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
SmartFeedUpdateInput!
|
Example
Query
mutation smartFeedUpdate($input: SmartFeedUpdateInput!) {
smartFeedUpdate(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
smartFeed {
...SmartFeedFragment
}
}
}
Variables
{"input": SmartFeedUpdateInput}
Response
{
"data": {
"smartFeedUpdate": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError],
"smartFeed": SmartFeed
}
}
}
spaceAdd
Description
Create a new space. require MeActions.spaceAdd or SpaceGroupActions.spaceAdd depending on your input
Response
Returns a
SpaceAddPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceAddInput!
|
Example
Query
mutation spaceAdd($input: SpaceAddInput!) {
spaceAdd(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
space {
...SpaceFragment
}
}
}
Variables
{"input": SpaceAddInput}
Response
{
"data": {
"spaceAdd": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"space": Space
}
}
}
spaceAddRequest
Description
Send a request to create a space. This will notify administrator of the platform. you need MeActions.spaceAddRequest or SpaceGroupActions.spaceAddRequest depending on your input
Response
Returns a
SpaceAddRequestPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceAddRequestInput!
|
Example
Query
mutation spaceAddRequest($input: SpaceAddRequestInput!) {
spaceAddRequest(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
space {
...SpaceFragment
}
}
}
Variables
{"input": SpaceAddRequestInput}
Response
{
"data": {
"spaceAddRequest": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"space": Space
}
}
}
spaceDelete
Description
Delete an existing Space you need SpaceActions.delete to be able to delete a space
Response
Returns a
SpaceDeletePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceDeleteInput!
|
Example
Query
mutation spaceDelete($input: SpaceDeleteInput!) {
spaceDelete(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
id
deletedId
}
}
Variables
{"input": SpaceDeleteInput}
Response
{
"data": {
"spaceDelete": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
"deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA=="
}
}
}
spaceFavorite
Description
Favorite a space you are member of.
Response
Returns a
SpaceFavoritePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceFavoriteInput!
|
Example
Query
mutation spaceFavorite($input: SpaceFavoriteInput!) {
spaceFavorite(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
space {
...SpaceFragment
}
}
}
Variables
{"input": SpaceFavoriteInput}
Response
{
"data": {
"spaceFavorite": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"space": Space
}
}
}
spaceGroupAdd
Description
Create a new SpaceGroup you need MeActions.spaceGroupAdd
Response
Returns a
SpaceGroupAddPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceGroupAddInput!
|
Example
Query
mutation spaceGroupAdd($input: SpaceGroupAddInput!) {
spaceGroupAdd(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
spaceGroup {
...SpaceGroupFragment
}
}
}
Variables
{"input": SpaceGroupAddInput}
Response
{
"data": {
"spaceGroupAdd": {
"clientMutationId": "abc123",
"errors": [PermissionError],
"spaceGroup": SpaceGroup
}
}
}
spaceGroupDelete
Description
Delete a SpaceGroup you need SpaceGroupActions.edit
Response
Returns a
SpaceGroupDeletePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceGroupDeleteInput!
|
Example
Query
mutation spaceGroupDelete($input: SpaceGroupDeleteInput!) {
spaceGroupDelete(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": SpaceGroupDeleteInput}
Response
{
"data": {
"spaceGroupDelete": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError]
}
}
}
spaceGroupOrder
Description
Order SpaceGroups between each others
Response
Returns a
SpaceGroupOrderPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceGroupOrderInput!
|
Example
Query
mutation spaceGroupOrder($input: SpaceGroupOrderInput!) {
spaceGroupOrder(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
}
spaceGroups {
...SpaceGroupFragment
}
}
}
Variables
{"input": SpaceGroupOrderInput}
Response
{
"data": {
"spaceGroupOrder": {
"clientMutationId": "abc123",
"errors": [PermissionError],
"spaceGroups": [SpaceGroup]
}
}
}
spaceGroupUpdate
Response
Returns a
SpaceGroupUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceGroupUpdateInput!
|
Example
Query
mutation spaceGroupUpdate($input: SpaceGroupUpdateInput!) {
spaceGroupUpdate(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
spaceGroup {
...SpaceGroupFragment
}
}
}
Variables
{"input": SpaceGroupUpdateInput}
Response
{
"data": {
"spaceGroupUpdate": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"spaceGroup": SpaceGroup
}
}
}
spaceJoin
Description
Join a Space requires Space.actions.join, you'll then see news about this in your feeds. You may also use spaceRequest for moderated spaces
Response
Returns a
SpaceJoinPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceJoinInput!
|
Example
Query
mutation spaceJoin($input: SpaceJoinInput!) {
spaceJoin(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
space {
...SpaceFragment
}
}
}
Variables
{"input": SpaceJoinInput}
Response
{
"data": {
"spaceJoin": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError],
"space": Space
}
}
}
spaceLeave
Description
Join a Space requires Space.actions.leave
Response
Returns a
SpaceLeavePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceLeaveInput!
|
Example
Query
mutation spaceLeave($input: SpaceLeaveInput!) {
spaceLeave(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
space {
...SpaceFragment
}
}
}
Variables
{"input": SpaceLeaveInput}
Response
{
"data": {
"spaceLeave": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"space": Space
}
}
}
spaceMemberAdd
Description
Add a new member(s) (User, Team) to a Space
Response
Returns a
SpaceMemberAddPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceMemberAddInput!
|
Example
Query
mutation spaceMemberAdd($input: SpaceMemberAddInput!) {
spaceMemberAdd(input: $input) {
background
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
member {
...SpaceMemberFragment
}
edge {
...SpaceMemberEdgeFragment
}
}
}
Variables
{"input": SpaceMemberAddInput}
Response
{
"data": {
"spaceMemberAdd": {
"background": true,
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError],
"member": SpaceMember,
"edge": SpaceMemberEdge
}
}
}
spaceMemberDelete
Description
Remove a SpaceMember from a Space
Response
Returns a
SpaceMemberDeletePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceMemberDeleteInput!
|
Example
Query
mutation spaceMemberDelete($input: SpaceMemberDeleteInput!) {
spaceMemberDelete(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
deletedId
}
}
Variables
{"input": SpaceMemberDeleteInput}
Response
{
"data": {
"spaceMemberDelete": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA=="
}
}
}
spaceMemberRole
Description
Change the role of a SpaceMember in the Space
Response
Returns a
SpaceMemberRolePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceMemberRoleInput!
|
Example
Query
mutation spaceMemberRole($input: SpaceMemberRoleInput!) {
spaceMemberRole(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
member {
...SpaceMemberFragment
}
}
}
Variables
{"input": SpaceMemberRoleInput}
Response
{
"data": {
"spaceMemberRole": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError],
"member": SpaceMember
}
}
}
spaceOrder
Description
Order spaces in a SpaceGroup. Spaces can Only be ordered inside their Common SaceGroups
Response
Returns a
SpaceOrderPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceOrderInput!
|
Example
Query
mutation spaceOrder($input: SpaceOrderInput!) {
spaceOrder(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
spaces {
...SpaceFragment
}
}
}
Variables
{"input": SpaceOrderInput}
Response
{
"data": {
"spaceOrder": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"spaces": [Space]
}
}
}
spaceRequest
Description
Request the creation of a space. This will notify administrator of the platform. require MeActions.spaceAddRequest or SpaceGroupActions.spaceAddRequest depending on your input
Response
Returns a
SpaceRequestPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceRequestInput!
|
Example
Query
mutation spaceRequest($input: SpaceRequestInput!) {
spaceRequest(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
space {
...SpaceFragment
}
}
}
Variables
{"input": SpaceRequestInput}
Response
{
"data": {
"spaceRequest": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError],
"space": Space
}
}
}
spaceRequestAccept
Response
Returns a
SpaceRequestAcceptPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceRequestAcceptInput!
|
Example
Query
mutation spaceRequestAccept($input: SpaceRequestAcceptInput!) {
spaceRequestAccept(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
member {
...SpaceMemberFragment
}
}
}
Variables
{"input": SpaceRequestAcceptInput}
Response
{
"data": {
"spaceRequestAccept": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"member": SpaceMember
}
}
}
spaceStatus
Response
Returns a
SpaceStatusPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceStatusInput!
|
Example
Query
mutation spaceStatus($input: SpaceStatusInput!) {
spaceStatus(input: $input) {
clientMutationId
space {
...SpaceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
}
}
Variables
{"input": SpaceStatusInput}
Response
{
"data": {
"spaceStatus": {
"clientMutationId": "abc123",
"space": Space,
"errors": [ObjectNotFoundError]
}
}
}
spaceTabDelete
Response
Returns a
SpaceTabDeletePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceTabDeleteInput!
|
Example
Query
mutation spaceTabDelete($input: SpaceTabDeleteInput!) {
spaceTabDelete(input: $input) {
clientMutationId
space {
...SpaceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": SpaceTabDeleteInput}
Response
{
"data": {
"spaceTabDelete": {
"clientMutationId": "abc123",
"space": Space,
"errors": [ObjectNotFoundError]
}
}
}
spaceTabOrder
Response
Returns a
SpaceTabOrderPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceTabOrderInput!
|
Example
Query
mutation spaceTabOrder($input: SpaceTabOrderInput!) {
spaceTabOrder(input: $input) {
clientMutationId
space {
...SpaceFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
}
}
Variables
{"input": SpaceTabOrderInput}
Response
{
"data": {
"spaceTabOrder": {
"clientMutationId": "xyz789",
"space": Space,
"errors": [ObjectNotFoundError]
}
}
}
spaceTabUpdate
Description
Update or create a SpaceTab. If you create a new one, don't pass an id and make sure to give a type
Response
Returns a
SpaceTabUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceTabUpdateInput!
|
Example
Query
mutation spaceTabUpdate($input: SpaceTabUpdateInput!) {
spaceTabUpdate(input: $input) {
clientMutationId
space {
...SpaceFragment
}
spaceTab {
...SpaceTabFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
... on MissingTypeInputError {
...MissingTypeInputErrorFragment
}
}
}
}
Variables
{"input": SpaceTabUpdateInput}
Response
{
"data": {
"spaceTabUpdate": {
"clientMutationId": "abc123",
"space": Space,
"spaceTab": SpaceTab,
"errors": [ObjectNotFoundError]
}
}
}
spaceUnFavorite
Description
Remove a space from your favorites.
Response
Returns a
SpaceUnFavoritePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceUnFavoriteInput!
|
Example
Query
mutation spaceUnFavorite($input: SpaceUnFavoriteInput!) {
spaceUnFavorite(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
space {
...SpaceFragment
}
}
}
Variables
{"input": SpaceUnFavoriteInput}
Response
{
"data": {
"spaceUnFavorite": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError],
"space": Space
}
}
}
spaceUnrequest
Response
Returns a
SpaceUnrequestPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceUnrequestInput!
|
Example
Query
mutation spaceUnrequest($input: SpaceUnrequestInput!) {
spaceUnrequest(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
space {
...SpaceFragment
}
}
}
Variables
{"input": SpaceUnrequestInput}
Response
{
"data": {
"spaceUnrequest": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError],
"space": Space
}
}
}
spaceUpdate
Description
Update the configuration of a given space (name, description, logo, etc.) need SpaceActions.edit to be able to update a space
Response
Returns a
SpaceUpdatePayload
Arguments
| Name | Description |
|---|---|
input -
SpaceUpdateInput!
|
Example
Query
mutation spaceUpdate($input: SpaceUpdateInput!) {
spaceUpdate(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
space {
...SpaceFragment
}
}
}
Variables
{"input": SpaceUpdateInput}
Response
{
"data": {
"spaceUpdate": {
"clientMutationId": "xyz789",
"errors": [ObjectNotFoundError],
"space": Space
}
}
}
spaceUpdatePinned
Response
Returns a
SpaceUpdatePinnedPayload
Arguments
| Name | Description |
|---|---|
input -
SpaceUpdatePinnedInput!
|
Example
Query
mutation spaceUpdatePinned($input: SpaceUpdatePinnedInput!) {
spaceUpdatePinned(input: $input) {
clientMutationId
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on PermissionError {
...PermissionErrorFragment
}
}
space {
...SpaceFragment
}
}
}
Variables
{"input": SpaceUpdatePinnedInput}
Response
{
"data": {
"spaceUpdatePinned": {
"clientMutationId": "abc123",
"errors": [ObjectNotFoundError],
"space": Space
}
}
}
storyApprovalCancel
Description
Cancel a StoryApproval.
Response
Returns a
StoryApprovalCancelPayload
Arguments
| Name | Description |
|---|---|
input -
StoryApprovalCancelInput!
|
Example
Query
mutation storyApprovalCancel($input: StoryApprovalCancelInput!) {
storyApprovalCancel(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
story {
...StoryFragment
}
approval {
...StoryApprovalFragment
}
}
}
Variables
{"input": StoryApprovalCancelInput}
Response
{
"data": {
"storyApprovalCancel": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"story": Story,
"approval": StoryApproval
}
}
}
storyApprovalEdit
Description
Change the status of a StoryApproval.
Response
Returns a
StoryApprovalEditPayload
Arguments
| Name | Description |
|---|---|
input -
StoryApprovalEditInput!
|
Example
Query
mutation storyApprovalEdit($input: StoryApprovalEditInput!) {
storyApprovalEdit(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
... on InvalidInputError {
...InvalidInputErrorFragment
}
}
story {
...StoryFragment
}
approval {
...StoryApprovalFragment
}
}
}
Variables
{"input": StoryApprovalEditInput}
Response
{
"data": {
"storyApprovalEdit": {
"clientMutationId": "xyz789",
"errors": [PermissionError],
"story": Story,
"approval": StoryApproval
}
}
}
storyApprovalRequest
Description
Request an Approval on a given story.
This might need to be required to be able to publish your content. see Space.isApprovalMandatory
Response
Returns a
StoryApprovalRequestPayload
Arguments
| Name | Description |
|---|---|
input -
StoryApprovalRequestInput!
|
Example
Query
mutation storyApprovalRequest($input: StoryApprovalRequestInput!) {
storyApprovalRequest(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
story {
...StoryFragment
}
approval {
...StoryApprovalFragment
}
}
}
Variables
{"input": StoryApprovalRequestInput}
Response
{
"data": {
"storyApprovalRequest": {
"clientMutationId": "abc123",
"errors": [PermissionError],
"story": Story,
"approval": StoryApproval
}
}
}
storyArchive
Description
Archive or Unarchive a story. archived give the status (true: archived, false: unarchive)
Response
Returns a
StoryArchivePayload
Arguments
| Name | Description |
|---|---|
input -
StoryArchiveInput!
|
Example
Query
mutation storyArchive($input: StoryArchiveInput!) {
storyArchive(input: $input) {
clientMutationId
errors {
... on PermissionError {
...PermissionErrorFragment
}
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
story {
...StoryFragment
}
}
}
Variables
{"input": StoryArchiveInput}
Response
{
"data": {
"storyArchive": {
"clientMutationId": "abc123",
"errors": [PermissionError],
"story": Story
}
}
}
storyBookmark
Response
Returns a
StoryBookmarkPayload
Arguments
| Name | Description |
|---|---|
input -
StoryBookmarkInput!
|
Example
Query
mutation storyBookmark($input: StoryBookmarkInput!) {
storyBookmark(input: $input) {
clientMutationId
me {
...MeFragment
}
story {
...StoryFragment
}
errors {
... on ObjectNotFoundError {
...ObjectNotFoundErrorFragment
}
}
}
}
Variables
{"input": StoryBookmarkInput}
Response
{
"data":