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
    }
    usersWithSuccession {
      ...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
    }
    smartAssistants {
      ...SmartAssistantConnectionFragment
    }
    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,
      "usersWithSuccession": UserConnection,
      "duplicatedAssets": DuplicatedAssetConnection,
      "disclaimer": false,
      "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": false,
      "onboardingCompletedSteps": [
        "abc123"
      ],
      "realtimeUrl": "http://www.test.com/",
      "refiner": InstanceRefiner,
      "release": "abc123",
      "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,
      "smartAssistants": SmartAssistantConnection,
      "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": "525c1940-9dfd-4f64-a159-78e5124da377"
}
Response
{
  "data": {
    "instanceActivationToken": {
      "email": "test@test.com",
      "errorCode": "EXISTING_USER",
      "lang": "abc123",
      "mixpanelToken": "xyz789",
      "mixpanelHost": "xyz789"
    }
  }
}

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": "abc123",
      "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
    annotations {
      ...AnnotationConnectionFragment
    }
    smartConversations {
      ...SmartConversationConnectionFragment
    }
    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
      }
    }
    ownedContentWithAnnotations {
      ...StoryConnectionFragment
    }
    myContent {
      ...StoryConnectionFragment
    }
    notifications {
      ...NotificationConnectionFragment
    }
    notificationsPreferences {
      ...MeNotificationsPreferencesFragment
    }
    personalContent {
      ...StoryConnectionFragment
    }
    preferences {
      ...MePreferencesFragment
    }
    presenceToken
    quickSearch {
      ...QuickSearchResponseFragment
    }
    schemas {
      ...StorySchemaFragment
    }
    search {
      ...StorySearchResponseFragment
    }
    searchGlobalTags {
      ...TagResultFragment
    }
    searchTags {
      ...TagResultFragment
    }
    searchHashtags {
      ...HashtagResultFragment
    }
    smartFeeds {
      ...SmartFeedConnectionFragment
    }
    smartAssistants {
      ...SmartAssistantConnectionFragment
    }
    spaceGroups {
      ...SpaceGroupConnectionFragment
    }
    spaces {
      ...SpaceConnectionFragment
    }
    storiesByAsset {
      ...StoryFragment
    }
    subscriptionToken
    unreadDiscussionsCount
    user {
      ...UserFragment
    }
  }
}
Response
{
  "data": {
    "me": {
      "actions": MeActions,
      "activities": ActivityConnection,
      "aiCompletion": "xyz789",
      "annotations": AnnotationConnection,
      "smartConversations": SmartConversationConnection,
      "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],
      "ownedContentWithAnnotations": StoryConnection,
      "myContent": StoryConnection,
      "notifications": NotificationConnection,
      "notificationsPreferences": MeNotificationsPreferences,
      "personalContent": StoryConnection,
      "preferences": MePreferences,
      "presenceToken": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "quickSearch": QuickSearchResponse,
      "schemas": [StorySchema],
      "search": StorySearchResponse,
      "searchGlobalTags": [TagResult],
      "searchTags": [TagResult],
      "searchHashtags": [HashtagResult],
      "smartFeeds": SmartFeedConnection,
      "smartAssistants": SmartAssistantConnection,
      "spaceGroups": SpaceGroupConnection,
      "spaces": SpaceConnection,
      "storiesByAsset": [Story],
      "subscriptionToken": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "unreadDiscussionsCount": 123,
      "user": User
    }
  }
}

node

Description

Get any node object via the Graphql unique ID

Response

Returns a Node

Arguments
Name Description
id - ID

Example

Query
query node($id: ID) {
  node(id: $id) {
    id
  }
}
Variables
{"id": "eWVhaCByaWdodCBpdCdzIGI2NA=="}
Response
{
  "data": {
    "node": {
      "id": "eWVhaCByaWdodCBpdCdzIGI2NA=="
    }
  }
}

nodes

Description

Get a list of node objects via their ids. see node resolver

Response

Returns [Node]

Arguments
Name Description
ids - [ID!]!

Example

Query
query nodes($ids: [ID!]!) {
  nodes(ids: $ids) {
    id
  }
}
Variables
{"ids": ["eWVhaCByaWdodCBpdCdzIGI2NA=="]}
Response
{
  "data": {
    "nodes": [
      {"id": "eWVhaCByaWdodCBpdCdzIGI2NA=="}
    ]
  }
}

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
    metadataUrl
    assertionsSigned
    messagesSigned
    signatureAlgorithm
    digestAlgorithm
  }
}
Variables
{"subdomain": "xyz789"}
Response
{
  "data": {
    "organization": {
      "id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "subdomain": "xyz789",
      "name": "abc123",
      "created": "2016-10-07T01:08:03.420Z",
      "saml2Enabled": false,
      "transparentAuth": false,
      "allowCreate": true,
      "metadata": "xyz789",
      "metadataUrl": "http://www.test.com/",
      "assertionsSigned": true,
      "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": "xyz789",
      "uuid": "abc123",
      "accentColor": "#CCCCCC",
      "headerColor": "#CCCCCC",
      "headerTextLightness": "DARK",
      "logoImageUrl": "http://www.test.com/",
      "googleAnalyticsTrackingId": "xyz789",
      "baseUrl": "http://www.test.com/",
      "domain": "xyz789",
      "release": "abc123",
      "mixpanel": PublicInstanceMixpanel,
      "sandboxUrl": "http://www.test.com/"
    }
  }
}

publicStory

Description

Fetch a publicly shared content by token and lang

Response

Returns a PublicStory

Arguments
Name Description
token - String!
lang - Lang

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": "xyz789",
  "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)

Response

Returns a Space

Arguments
Name Description
slug - Int!

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": "abc123",
      "id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "intro": RichContent,
      "intros": [TranslatedRichContent],
      "isDefault": true,
      "isApprovalMandatory": false,
      "meRole": "ADMIN",
      "meFavorited": false,
      "membersAddCompletion": [User],
      "membersCount": 123,
      "membersDownload": "http://www.test.com/",
      "name": "xyz789",
      "names": {"en": "a Name", "fr": "Un Nom"},
      "notifyAdminsOnPost": false,
      "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": false,
      "showPopularUsers": false,
      "showRecentUsers": true,
      "showRecomendedUsers": false,
      "showTopContributors": true,
      "slug": 987,
      "spaceGroup": SpaceGroup,
      "spaceMembers": SpaceMemberConnection,
      "spaceUsers": UserConnection,
      "status": "CLOSED",
      "suggestedTags": [Tag],
      "tabs": [SpaceTab],
      "tags": [Tag],
      "thumbnailImage": "http://www.test.com/",
      "thumbnailImageDigest": "xyz789",
      "type": "PUBLIC"
    }
  }
}

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": true,
      "color": "#CCCCCC",
      "headerImage": "http://www.test.com/",
      "headerImageDigest": "abc123",
      "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

Response

Returns a Story

Arguments
Name Description
slug - Int!

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": 123}
Response
{
  "data": {
    "statusStory": {
      "actions": StoryActions,
      "added": "2016-10-07T01:08:03.420Z",
      "analytics": StoryAnalytics,
      "bookmarked": true,
      "approval": StoryApproval,
      "commenters": UserConnection,
      "comments": CommentConnection,
      "contributors": UserConnection,
      "diffVersions": StoryVersionsDiff,
      "editVersion": StoryVersion,
      "editVersionUUID": "525c1940-9dfd-4f64-a159-78e5124da377",
      "event": Event,
      "expireAt": "2016-10-07T01:08:03.420Z",
      "followed": true,
      "followers": UserConnection,
      "globallyPinned": false,
      "grants": [StoryGrant],
      "hasSpace": true,
      "hashtags": [Hashtag],
      "id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "invitables": InvitableConnection,
      "invitations": InvitationConnection,
      "inviteContributors": [User],
      "isPublished": false,
      "isSpaceClosed": false,
      "lastExpiration": StoryExpirationHistory,
      "layoutMode": "SMALL",
      "hideReadTime": false,
      "legacy": false,
      "liked": false,
      "likers": UserConnection,
      "pinned": true,
      "publicUrl": "http://www.test.com/",
      "publicSharedBy": User,
      "publicShared": "2016-10-07T01:08:03.420Z",
      "relateds": StoryConnection,
      "reshared": false,
      "resharedAs": [Story],
      "resharedAsCount": 987,
      "resharedFrom": Story,
      "restricted": false,
      "schema": StorySchema,
      "confidentialContent": false,
      "share": Share,
      "slug": 987,
      "space": Space,
      "status": "DELETED",
      "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)

Response

Returns a Story

Arguments
Name Description
slug - Int!

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": true,
      "approval": StoryApproval,
      "commenters": UserConnection,
      "comments": CommentConnection,
      "contributors": UserConnection,
      "diffVersions": StoryVersionsDiff,
      "editVersion": StoryVersion,
      "editVersionUUID": "525c1940-9dfd-4f64-a159-78e5124da377",
      "event": Event,
      "expireAt": "2016-10-07T01:08:03.420Z",
      "followed": false,
      "followers": UserConnection,
      "globallyPinned": false,
      "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": true,
      "publicUrl": "http://www.test.com/",
      "publicSharedBy": User,
      "publicShared": "2016-10-07T01:08:03.420Z",
      "relateds": StoryConnection,
      "reshared": false,
      "resharedAs": [Story],
      "resharedAsCount": 987,
      "resharedFrom": Story,
      "restricted": true,
      "schema": StorySchema,
      "confidentialContent": true,
      "share": Share,
      "slug": 987,
      "space": Space,
      "status": "DELETED",
      "subscriptionToken": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "suggestedTags": [Tag],
      "tags": [Tag],
      "type": "xyz789",
      "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
    }
  }
}

storyReshares

Description

Get a list of stories that are reshares of the current story. This may allow viewing an alternative reshare if you don't have access.

Response

Returns [Story!]!

Arguments
Name Description
slug - Int!

Example

Query
query storyReshares($slug: Int!) {
  storyReshares(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": 123}
Response
{
  "data": {
    "storyReshares": [
      {
        "actions": StoryActions,
        "added": "2016-10-07T01:08:03.420Z",
        "analytics": StoryAnalytics,
        "bookmarked": true,
        "approval": StoryApproval,
        "commenters": UserConnection,
        "comments": CommentConnection,
        "contributors": UserConnection,
        "diffVersions": StoryVersionsDiff,
        "editVersion": StoryVersion,
        "editVersionUUID": "525c1940-9dfd-4f64-a159-78e5124da377",
        "event": Event,
        "expireAt": "2016-10-07T01:08:03.420Z",
        "followed": false,
        "followers": UserConnection,
        "globallyPinned": true,
        "grants": [StoryGrant],
        "hasSpace": true,
        "hashtags": [Hashtag],
        "id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
        "invitables": InvitableConnection,
        "invitations": InvitationConnection,
        "inviteContributors": [User],
        "isPublished": true,
        "isSpaceClosed": false,
        "lastExpiration": StoryExpirationHistory,
        "layoutMode": "SMALL",
        "hideReadTime": false,
        "legacy": true,
        "liked": true,
        "likers": UserConnection,
        "pinned": true,
        "publicUrl": "http://www.test.com/",
        "publicSharedBy": User,
        "publicShared": "2016-10-07T01:08:03.420Z",
        "relateds": StoryConnection,
        "reshared": false,
        "resharedAs": [Story],
        "resharedAsCount": 987,
        "resharedFrom": Story,
        "restricted": true,
        "schema": StorySchema,
        "confidentialContent": true,
        "share": Share,
        "slug": 987,
        "space": Space,
        "status": "DELETED",
        "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
      }
    ]
  }
}

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": "abc123",
      "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)

Response

Returns a User

Arguments
Name Description
slug - Int!

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
    spaceWithSuccessionCount
    status
    tags {
      ...TagFragment
    }
    twoFactorSetupDate
    watchToken
  }
}
Variables
{"slug": 123}
Response
{
  "data": {
    "user": {
      "actions": UserActions,
      "attributes": [Attribute],
      "banner": "http://www.test.com/",
      "builtins": [BuiltinAttribute],
      "downloadsCount": 987,
      "primaryEmail": "test@test.com",
      "userName": "abc123",
      "commonSpaces": SpaceConnection,
      "contentCount": 987,
      "cover": "http://www.test.com/",
      "coverDigest": "xyz789",
      "description": "xyz789",
      "feed": ActivityFeedItemConnection,
      "followed": true,
      "followers": UserConnection,
      "following": UserConnection,
      "hasTwoFactorEnabled": true,
      "hashtags": [Hashtag],
      "id": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "lastVisit": "2016-10-07T01:08:03.420Z",
      "spacesWithUserContent": [Succession],
      "successorContentCount": 987,
      "memberSince": "2016-10-07T01:08:03.420Z",
      "mustEnableTwoFactor": false,
      "name": "abc123",
      "photo": "http://www.test.com/",
      "photoDigest": "xyz789",
      "presence": [UserPresence],
      "role": "ADMINISTRATOR",
      "schema": UserSchema,
      "search": StorySearchResponse,
      "slug": 123,
      "spaceContentCount": 987,
      "spaceWithSuccessionCount": 123,
      "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! Required Parameter for the alertCreate Mutation

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! Required Parameter for the alertDelete Mutation

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! Required Parameter for the alertEdit Mutation

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": "abc123",
      "errors": [PermissionError]
    }
  }
}

alertSubscription

Description

Edit subscription (sending preferences) of an Alert

Response

Returns an AlertSubscriptionPayload

Arguments
Name Description
input - AlertSubscriptionInput! Required Parameter for the alertSubscription Mutation

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": "xyz789",
      "errors": [ObjectNotFoundError]
    }
  }
}

analyticsSignal

Description

Send signal about read or impression made by a user

Response

Returns an AnalyticsSignalPayload

Arguments
Name Description
input - AnalyticsSignalInput! Required Parameter for the analyticsSignal Mutation

Example

Query
mutation analyticsSignal($input: AnalyticsSignalInput!) {
  analyticsSignal(input: $input) {
    clientMutationId
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": AnalyticsSignalInput}
Response
{
  "data": {
    "analyticsSignal": {
      "clientMutationId": "xyz789",
      "me": Me
    }
  }
}

annotationCommentAdd

Description

Add a reply (AnnotationComment) to an Annotation requires AnnotationActions.reply

Response

Returns an AnnotationCommentAddPayload

Arguments
Name Description
input - AnnotationCommentAddInput! Required Input for the annotationCommentAdd Mutation

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! Required Input for the annotationCommentDelete Mutation

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": "xyz789",
      "annotationCommentId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "errors": [ObjectNotFoundError]
    }
  }
}

annotationCommentEdit

Description

Edit an AnnotationComment text content requires AnnotationCommentActions.edit

Response

Returns an AnnotationCommentEditPayload

Arguments
Name Description
input - AnnotationCommentEditInput! Required Input for the annotationCommentEdit Mutation

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! Required Parameter for the annotationCreate Mutation

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": "abc123",
      "story": Story,
      "annotationEdge": AnnotationEdge,
      "errors": [ObjectNotFoundError]
    }
  }
}

annotationDelete

Description

Delete an Annotation requires AnnotationActions.delete

Response

Returns an AnnotationDeletePayload

Arguments
Name Description
input - AnnotationDeleteInput! Required Parameter for the annotationDelete Mutation

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": "abc123",
      "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! Required Parameter for the annotationEdit Mutation

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! Required Parameter for the answerFeedback Mutation

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! Required Parameter for the answerResolve Mutation

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
    }
  }
}

answerSendForReview

Description

Send a Question and answers to Elium's team for review and improvement

Response

Returns an AnswerSendForReviewPayload

Arguments
Name Description
input - AnswerSendForReviewInput! Input of the mutation

Example

Query
mutation answerSendForReview($input: AnswerSendForReviewInput!) {
  answerSendForReview(input: $input) {
    clientMutationId
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
      ... on UnconfiguredServiceError {
        ...UnconfiguredServiceErrorFragment
      }
    }
    answer {
      ...AnswerFragment
    }
  }
}
Variables
{"input": AnswerSendForReviewInput}
Response
{
  "data": {
    "answerSendForReview": {
      "clientMutationId": "abc123",
      "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! Required Parameter for the appLauncherCreate Mutation

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": "xyz789",
      "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! Required Parameter for the appLauncherDelete Mutation

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! Required Parameter for the appLauncherEdit Mutation

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": "abc123",
      "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! Required Parameter for the appLauncherOrder Mutation

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! Required Parameter for the assetPreview Mutation

Example

Query
mutation assetPreview($input: StoryAssetInput!) {
  assetPreview(input: $input) {
    asset {
      ...AssetFragment
    }
    clientMutationId
  }
}
Variables
{"input": StoryAssetInput}
Response
{
  "data": {
    "assetPreview": {
      "asset": Asset,
      "clientMutationId": "xyz789"
    }
  }
}

bulkStoryDelete

Description

Delete Stories in bulk

Response

Returns a BulkStoryDeletePayload

Arguments
Name Description
input - BulkStoryDeleteInput! Required Parameter for the bulkStoryDelete Mutation

Example

Query
mutation bulkStoryDelete($input: BulkStoryDeleteInput!) {
  bulkStoryDelete(input: $input) {
    clientMutationId
    deletedIds
    skippedIds
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": BulkStoryDeleteInput}
Response
{
  "data": {
    "bulkStoryDelete": {
      "clientMutationId": "xyz789",
      "deletedIds": [
        "eWVhaCByaWdodCBpdCdzIGI2NA=="
      ],
      "skippedIds": [
        "eWVhaCByaWdodCBpdCdzIGI2NA=="
      ],
      "me": Me
    }
  }
}

bulkStoryMove

Description

Move Stories in bulk

Response

Returns a BulkStoryMovePayload

Arguments
Name Description
input - BulkStoryMoveInput! Required Parameter for the bulkStoryMove Mutation

Example

Query
mutation bulkStoryMove($input: BulkStoryMoveInput!) {
  bulkStoryMove(input: $input) {
    clientMutationId
    movedIds
    skippedIds
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
    }
    me {
      ...MeFragment
    }
    space {
      ...SpaceFragment
    }
  }
}
Variables
{"input": BulkStoryMoveInput}
Response
{
  "data": {
    "bulkStoryMove": {
      "clientMutationId": "abc123",
      "movedIds": [
        "eWVhaCByaWdodCBpdCdzIGI2NA=="
      ],
      "skippedIds": [
        "eWVhaCByaWdodCBpdCdzIGI2NA=="
      ],
      "errors": [PermissionError],
      "me": Me,
      "space": Space
    }
  }
}

bulkStorySchemaConvert

Description

Convert Multiple Stories to a Story with a given StorySchema Note: this only works for stories that are not already converted requires StoryAction.edit on each of the stories

Response

Returns a BulkStorySchemaConvertPayload

Arguments
Name Description
input - BulkStorySchemaConvertInput! Required Parameter for the bulkStoryMove Mutation

Example

Query
mutation bulkStorySchemaConvert($input: BulkStorySchemaConvertInput!) {
  bulkStorySchemaConvert(input: $input) {
    clientMutationId
    touchedIds
    skippedIds
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
    }
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": BulkStorySchemaConvertInput}
Response
{
  "data": {
    "bulkStorySchemaConvert": {
      "clientMutationId": "xyz789",
      "touchedIds": [
        "eWVhaCByaWdodCBpdCdzIGI2NA=="
      ],
      "skippedIds": [
        "eWVhaCByaWdodCBpdCdzIGI2NA=="
      ],
      "errors": [PermissionError],
      "me": Me
    }
  }
}

checkPassword

Description

Verify if the password is correct with a registration token

Response

Returns a CheckPasswordPayload

Arguments
Name Description
input - CheckPasswordInput! Required Parameter for the checkPassword Mutation

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": "abc123",
      "errors": [InvalidInputError],
      "success": true
    }
  }
}

commentDelete

Description

Delete a comment. requires CommentActions.delete

Response

Returns a CommentDeletePayload

Arguments
Name Description
input - CommentDeleteInput! Required Parameter for the commentDelete Mutation

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! Required Parameter for the commentEdit Mutation

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! Required Parameter for the commentLike Mutation

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! Required Parameter for the commentPost Mutation

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": "xyz789",
      "commentEdge": CommentEdge,
      "parent": Story,
      "errors": [ObjectNotFoundError]
    }
  }
}

connectedAppCreate

Description

Create a new ConnectedApp

Response

Returns a ConnectedAppCreatePayload

Arguments
Name Description
input - ConnectedAppCreateInput! Required Parameter for the connectedAppCreate Mutation

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": "xyz789",
      "connectedApp": ConnectedApp,
      "edge": ConnectedAppEdge,
      "instance": Instance,
      "errors": [ObjectNotFoundError]
    }
  }
}

connectedAppDelete

Description

Delete a single ConnectedApp object.

Response

Returns a ConnectedAppDeletePayload

Arguments
Name Description
input - ConnectedAppDeleteInput! Required Parameter for the connectedAppDelete Mutation

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! Required Parameter for the connectedAppEdit Mutation

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": "xyz789",
      "connectedApp": ConnectedApp,
      "instance": Instance,
      "errors": [ObjectNotFoundError]
    }
  }
}

contentLike

Description

Toggle Like status of a Story

Response

Returns a ContentLikePayload

Arguments
Name Description
input - ContentLikeInput! Required Parameter for the contentLike Mutation

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! Required Input for the disableStandardContent Mutation

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": "xyz789",
      "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! Required Input for the emailPipelineCreate Mutation

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": "xyz789",
      "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! Required Input for the emailPipelineDelete Mutation

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! Required Parameter for the emailPipelineEdit Mutation

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": "xyz789",
      "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! Required Parameter for the eventInvite Mutation

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! Required Parameter for the eventRespond Mutation

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": "abc123",
      "story": Story,
      "errors": [PermissionError]
    }
  }
}

facetCreate

Description

Create a facet (or category of tags)

Response

Returns a FacetCreatePayload

Arguments
Name Description
input - FacetCreateInput! Required Parameter for the facetCreate Mutation

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": "xyz789",
      "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! Required Parameter for the folderAddTag Mutation

Example

Query
mutation folderAddTag($input: FolderAddTagInput!) {
  folderAddTag(input: $input) {
    clientMutationId
    errors {
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
      ... on PermissionError {
        ...PermissionErrorFragment
      }
    }
  }
}
Variables
{"input": FolderAddTagInput}
Response
{
  "data": {
    "folderAddTag": {
      "clientMutationId": "xyz789",
      "errors": [ObjectNotFoundError]
    }
  }
}

folderDelete

Description

Delete a given Folder

Response

Returns a FolderDeletePayload

Arguments
Name Description
input - FolderDeleteInput! Required Parameter for the folderDelete Mutation

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 the contents of a folder to another space or attribute the contents to another owner

Response

Returns a FolderMovePayload

Arguments
Name Description
input - FolderMoveInput! Required Parameter for the folderMove Mutation

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": "abc123",
      "errors": [ObjectNotFoundError]
    }
  }
}

hashtagCreate

Description

Create a Hashtag (~ tag not linked to a category)

Response

Returns a HashtagCreatePayload

Arguments
Name Description
input - HashtagCreateInput! Required Parameter for the hashtagCreate Mutation

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": "xyz789",
      "hashtag": Hashtag,
      "me": Me,
      "errors": [PermissionError]
    }
  }
}

instanceActivate

Description

Activates an instance after the provisioning is done.

You'll need to get a Token from the provisioning service to be able to activate the instance

Response

Returns an InstanceActivatePayload

Arguments
Name Description
input - InstanceActivateInput! Required Parameter for the instanceActivate Mutation

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

Description

Cancels the subscription for an instance of the application. This mutation requires an InstanceCancelSubscriptionInput object that specifies the details needed to cancel the subscription.

Response

Returns an InstanceCancelSubscriptionPayload

Arguments
Name Description
input - InstanceCancelSubscriptionInput! Required Input for the instanceCancelSubscription Mutation

Example

Query
mutation instanceCancelSubscription($input: InstanceCancelSubscriptionInput!) {
  instanceCancelSubscription(input: $input) {
    clientMutationId
    instance {
      ...InstanceFragment
    }
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
    }
  }
}
Variables
{"input": InstanceCancelSubscriptionInput}
Response
{
  "data": {
    "instanceCancelSubscription": {
      "clientMutationId": "xyz789",
      "instance": Instance,
      "errors": [PermissionError]
    }
  }
}

instanceCompleteOnboadingStep

Description

Mark a step as completed (or skipped)

Arguments
Name Description
input - InstanceCompleteOnboadingStepInput! Required Input for the instanceCompleteOnboadingStep Mutation

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": "xyz789",
      "instance": Instance,
      "errors": [PermissionError]
    }
  }
}

instanceContactsUpdate

Description

Set A contact for the instance

Response

Returns an InstanceContactsUpdatePayload

Arguments
Name Description
input - InstanceContactsUpdateInput! Required Input for the instanceContactsUpdate Mutation

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

Description

Delete the whole instance and every data with it

Response

Returns an InstanceDeletePayload

Arguments
Name Description
input - InstanceDeleteInput! Required Parameter for the instanceDelete Mutation

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! Required Input for the instanceDisclaimerSetup Mutation

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": "abc123",
      "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! Required Parameter for the instanceExport Mutation

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": "abc123",
      "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

Arguments
Name Description
input - InstanceFinishProvisionningInput! Required Input for the instanceFinishProvisionning Mutation

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

Description

Setup Google Analytics Integration's configuration

Arguments
Name Description
input - InstanceGoogleAnalyticsUpdateInput! Required Input for the instanceGoogleAnalyticsUpdate Mutation

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

Description

Setup Google Drive Integration's configuration

Response

Returns an InstanceGoogleDriveUpdatePayload

Arguments
Name Description
input - InstanceGoogleDriveUpdateInput! Required Input for the instanceGoogleDriveUpdate Mutation

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! Required Input for the instanceInvoiceUpdate Mutation

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! Required Input for the instanceLabFlagUpdate Mutation

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

Arguments
Name Description
input - InstanceMicrosoftTeamsUpdateInput! Required Input for the instanceMicrosoftTeamsUpdate Mutation

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

Arguments
Name Description
input - InstanceMobileAppDescriptionsUpdateInput! Required Input for the instanceMobileAppDescriptionsUpdate Mutation

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": "abc123",
      "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! Required Input for the instanceOfficeOnlineUpdate Mutation

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": "xyz789",
      "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! Required Input for the instanceOneDriveUpdate Mutation

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! Required Input for the instanceScimConfigUpdate Mutation

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": "abc123",
      "errors": [PermissionError],
      "instance": Instance
    }
  }
}

instanceSettingsUpdate

Description

Change instance Settings, security, ... Requires me.actions.admin

Response

Returns an InstanceSettingsUpdatePayload!

Arguments
Name Description
input - InstanceSettingsUpdateInput! Required Input for the instanceSettingsUpdate Mutation

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! Required Input for the instanceSlackUpdate Mutation

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! Required Input for the instanceSsoConfigUpdate Mutation

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": "abc123",
      "errors": [PermissionError],
      "instance": Instance
    }
  }
}

instanceThemeUpdate

Description

Updates the theme settings for an instance of the application. Some of the settings need to have the white-labeling option in the plan

Response

Returns an InstanceThemeUpdatePayload

Arguments
Name Description
input - InstanceThemeUpdateInput! Required Input for the instanceThemeUpdate Mutation

Example

Query
mutation instanceThemeUpdate($input: InstanceThemeUpdateInput!) {
  instanceThemeUpdate(input: $input) {
    clientMutationId
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
    }
    instance {
      ...InstanceFragment
    }
  }
}
Variables
{"input": InstanceThemeUpdateInput}
Response
{
  "data": {
    "instanceThemeUpdate": {
      "clientMutationId": "xyz789",
      "errors": [PermissionError],
      "instance": Instance
    }
  }
}

instanceUpdateSubscription

Description

Updates the subscription (billing) of the instance. You can change plan, seats but you will need a payment intent from Chargebee.

requires me.actions.billing

Response

Returns an InstanceUpdateSubscriptionPayload

Arguments
Name Description
input - InstanceUpdateSubscriptionInput! Required Input for the instanceUpdateSubscription Mutation

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

Description

Updates the workplace settings for an instance of the application. This mutation requires an InstanceWorkplaceUpdateInput object that specifies the new workplace settings to be applied.

Response

Returns an InstanceWorkplaceUpdatePayload

Arguments
Name Description
input - InstanceWorkplaceUpdateInput! Required Input for the instanceWorkplaceUpdate Mutation

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! Required Input for the meActivateTwoFactor Mutation

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! Required Parameter for the meBookmarksClear Mutation

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! Required Input for the meDeviceTokenPublish Mutation

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": false,
      "errors": [ObjectNotFoundError]
    }
  }
}

meDeviceTokenRegister

Description

Register a Mobile device for the current user. This will allow to send PUSH notifications to the device for example.

Response

Returns a MeDeviceTokenRegisterPayload

Arguments
Name Description
input - MeDeviceTokenRegisterInput! Required Input for the meDeviceTokenRegister Mutation

Example

Query
mutation meDeviceTokenRegister($input: MeDeviceTokenRegisterInput!) {
  meDeviceTokenRegister(input: $input) {
    clientMutationId
    deviceToken {
      ...MeDeviceTokenFragment
    }
  }
}
Variables
{"input": MeDeviceTokenRegisterInput}
Response
{
  "data": {
    "meDeviceTokenRegister": {
      "clientMutationId": "abc123",
      "deviceToken": MeDeviceToken
    }
  }
}

meDeviceTokenUnregister

Description

Remove / de-associate a device from the current user. This will stop push notification to this device

Response

Returns a MeDeviceTokenUnregisterPayload

Arguments
Name Description
input - MeDeviceTokenUnregisterInput! Required Input for the meDeviceTokenUnregister Mutation

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

Description

Mark the "disclaimer" of the current user as accepted

Response

Returns a MeDisclaimerAcceptPayload

Arguments
Name Description
input - MeDisclaimerAcceptInput! Required Parameter for the meDisclaimerAccept Mutation

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

Arguments
Name Description
input - MeNotificationsPreferencesInput! Required Input for the meNotificationsPreferences Mutation

Example

Query
mutation meNotificationsPreferences($input: MeNotificationsPreferencesInput!) {
  meNotificationsPreferences(input: $input) {
    clientMutationId
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": MeNotificationsPreferencesInput}
Response
{
  "data": {
    "meNotificationsPreferences": {
      "clientMutationId": "xyz789",
      "me": Me
    }
  }
}

mePasswordChange

Description

Change the password of the current user

Response

Returns a MePasswordChangePayload

Arguments
Name Description
input - MePasswordChangeInput! Required Parameter for the mePasswordChange Mutation

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": "xyz789",
      "me": Me,
      "errors": [PermissionError]
    }
  }
}

mePreferencesUpdate

Description

Update the user's application preferences (emails, language, ...)

Response

Returns a MePreferencesUpdatePayload

Arguments
Name Description
input - MePreferencesUpdateInput! Required Input for the mePreferencesUpdate Mutation

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": "abc123",
      "me": Me,
      "errors": [EmailAlreadyExistsError]
    }
  }
}

mePresenceUpdate

Description

Update user's presence status on a given device

Response

Returns a MePresenceUpdatePayload

Arguments
Name Description
input - MePresenceUpdateInput! Required Parameter for the mePresenceUpdate Mutation

Example

Query
mutation mePresenceUpdate($input: MePresenceUpdateInput!) {
  mePresenceUpdate(input: $input) {
    clientMutationId
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": MePresenceUpdateInput}
Response
{
  "data": {
    "mePresenceUpdate": {
      "clientMutationId": "xyz789",
      "me": Me
    }
  }
}

meProfileSetupComplete

Description

Mark the profile setup as complete for the current user Thus the user can be considered as "onboarded" and fully setup

Response

Returns a MeProfileSetupCompletePayload

Arguments
Name Description
input - MeProfileSetupCompleteInput! Required Input for the meProfileSetupComplete Mutation

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! Required Parameter for the meRemoveTwoFactor Mutation

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": "abc123",
      "errors": [PermissionError],
      "me": Me
    }
  }
}

meServiceReset

Description

Reset the token of a given service

Response

Returns a MeServiceResetPayload

Arguments
Name Description
input - MeServiceResetInput! Required Parameter for the meServiceReset Mutation

Example

Query
mutation meServiceReset($input: MeServiceResetInput!) {
  meServiceReset(input: $input) {
    clientMutationId
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": MeServiceResetInput}
Response
{
  "data": {
    "meServiceReset": {
      "clientMutationId": "abc123",
      "me": Me
    }
  }
}

meServiceToken

Description

Obtain an Access token or refresh one for a given integration

Response

Returns a MeServiceTokenPayload

Arguments
Name Description
input - MeServiceTokenInput! Required Parameter for the meServiceToken Mutation

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": 123,
      "errors": [InvalidInputError]
    }
  }
}

meTokenReset

Description

Reset or Remove a token for a given service

Response

Returns a MeTokenResetPayload

Arguments
Name Description
input - MeTokenResetInput! Required Parameter for the meTokenReset Mutation

Example

Query
mutation meTokenReset($input: MeTokenResetInput!) {
  meTokenReset(input: $input) {
    clientMutationId
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": MeTokenResetInput}
Response
{
  "data": {
    "meTokenReset": {
      "clientMutationId": "abc123",
      "me": Me
    }
  }
}

microsoftTeamsActivitiesConfigUpdate

Description

Updates the activities for which a message should be pushed to teams

Arguments
Name Description
input - MicrosoftTeamsActivitiesConfigUpdateInput! Required Input for the microsoftTeamsActivitiesConfigUpdate Mutation

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

Arguments
Name Description
input - MicrosoftTeamsSpacesToChannelRemoveInput! Required Input for the microsoftTeamsSpacesToChannelRemove Mutation

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

Arguments
Name Description
input - MicrosoftTeamsSpacesToChannelUpdateInput! Required Input for the microsoftTeamsSpacesToChannelUpdate Mutation

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": "xyz789",
      "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! Required Input for the microsoftTeamsTabEmbed Mutation

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 Pining a notification will make it appear in the "pinned" list of notifications

Response

Returns a NotificationPinPayload

Arguments
Name Description
input - NotificationPinInput! Required Parameter for the notificationPin Mutation

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": "xyz789",
      "me": Me,
      "notification": Notification,
      "errors": [ObjectNotFoundError]
    }
  }
}

notificationsRead

Description

Mark a list of notifications as read

Response

Returns a NotificationsReadPayload

Arguments
Name Description
input - NotificationsReadInput! Required Parameter for the notificationsRead Mutation

Example

Query
mutation notificationsRead($input: NotificationsReadInput!) {
  notificationsRead(input: $input) {
    clientMutationId
    me {
      ...MeFragment
    }
    notifications {
      ...NotificationFragment
    }
  }
}
Variables
{"input": NotificationsReadInput}
Response
{
  "data": {
    "notificationsRead": {
      "clientMutationId": "abc123",
      "me": Me,
      "notifications": [Notification]
    }
  }
}

notificationsReadAll

Description

Mark ALL notifications as read

Response

Returns a NotificationsReadAllPayload

Arguments
Name Description
input - NotificationsReadAllInput! Required Input for the notificationsReadAll Mutation

Example

Query
mutation notificationsReadAll($input: NotificationsReadAllInput!) {
  notificationsReadAll(input: $input) {
    clientMutationId
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": NotificationsReadAllInput}
Response
{
  "data": {
    "notificationsReadAll": {
      "clientMutationId": "xyz789",
      "me": Me
    }
  }
}

notificationsSeenAll

Description

Mark All notifications as seen (seen notifications are not displayed in the "new" section of the notifications list)

Response

Returns a NotificationsSeenAllPayload

Arguments
Name Description
input - NotificationsSeenAllInput! Required Input for the notificationsSeenAll Mutation

Example

Query
mutation notificationsSeenAll($input: NotificationsSeenAllInput!) {
  notificationsSeenAll(input: $input) {
    clientMutationId
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": NotificationsSeenAllInput}
Response
{
  "data": {
    "notificationsSeenAll": {
      "clientMutationId": "xyz789",
      "me": Me
    }
  }
}

notificationsUnread

Description

Mark a notification as unread Probably used for debugging purposes

Response

Returns a NotificationsUnreadPayload

Arguments
Name Description
input - NotificationsUnreadInput! Required Input for the notificationsUnread Mutation

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! Required Parameter for the organizationCreate Mutation

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! Required Parameter for the organizationDelete Mutation

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": "xyz789",
      "deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "errors": [ObjectNotFoundError]
    }
  }
}

organizationUpdate

Description

Update the specified organization configuration and name

Response

Returns an OrganizationUpdatePayload

Arguments
Name Description
input - OrganizationUpdateInput! Required Parameter for the organizationUpdate Mutation

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": "abc123",
      "organization": Organization,
      "errors": [InvalidFormatError]
    }
  }
}

schemaAttributeCreate

Description

Create a StorySchema attribute you'll need schema edition right

Response

Returns a SchemaAttributeCreatePayload

Arguments
Name Description
input - SchemaAttributeCreateInput! Required Input for the schemaAttributeCreate Mutation

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": "abc123",
      "errors": [ObjectNotFoundError]
    }
  }
}

schemaAttributeDelete

Description

Delete a Template field, remove the field from all content

Response

Returns a SchemaAttributeDeletePayload

Arguments
Name Description
input - SchemaAttributeDeleteInput! Required Input for the schemaAttributeDelete Mutation

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": "xyz789",
      "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)

Arguments
Name Description
input - SchemaAttributeOptionCreateInput! Required Input for the schemaAttributeOptionCreate Mutation

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

Description

Update a StorySchema attribute (label, description) It's not possible to change the type of an attribute

Response

Returns a SchemaAttributeUpdatePayload

Arguments
Name Description
input - SchemaAttributeUpdateInput! Required Input for the schemaAttributeUpdate Mutation

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

Description

Create a new SchemaSeparator for display in a StorySchema

Response

Returns a SchemaSeparatorCreatePayload

Arguments
Name Description
input - SchemaSeparatorCreateInput! Required Input for the schemaSeparatorCreate Mutation

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! Required Parameter for the searchFeedback Mutation

Example

Query
mutation searchFeedback($input: SearchFeedbackInput!) {
  searchFeedback(input: $input) {
    clientMutationId
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": SearchFeedbackInput}
Response
{
  "data": {
    "searchFeedback": {
      "clientMutationId": "abc123",
      "me": Me
    }
  }
}

searchHistoryPost

Description

Insert search query history for later use like stats and improvements

Response

Returns a SearchHistoryPostPayload

Arguments
Name Description
input - SearchHistoryPostInput! Required Parameter for the searchHistoryPost Mutation

Example

Query
mutation searchHistoryPost($input: SearchHistoryPostInput!) {
  searchHistoryPost(input: $input) {
    clientMutationId
    me {
      ...MeFragment
    }
  }
}
Variables
{"input": SearchHistoryPostInput}
Response
{
  "data": {
    "searchHistoryPost": {
      "clientMutationId": "xyz789",
      "me": Me
    }
  }
}

sharePointAddSearchTab

Description

Create a new SharepointSearchTab integration for users

Response

Returns a SharePointAddSearchTabPayload

Arguments
Name Description
input - SharePointAddSearchTabInput! Required Input for the sharePointAddSearchTab Mutation

Example

Query
mutation sharePointAddSearchTab($input: SharePointAddSearchTabInput!) {
  sharePointAddSearchTab(input: $input) {
    searchTab {
      ...SharePointSearchTabFragment
    }
    clientMutationId
    instance {
      ...InstanceFragment
    }
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
      ... on UnconfiguredServiceError {
        ...UnconfiguredServiceErrorFragment
      }
    }
  }
}
Variables
{"input": SharePointAddSearchTabInput}
Response
{
  "data": {
    "sharePointAddSearchTab": {
      "searchTab": SharePointSearchTab,
      "clientMutationId": "xyz789",
      "instance": Instance,
      "errors": [PermissionError]
    }
  }
}

sharePointRemoveSearchTab

Description

Remove a SharepointSearchTab from the current instance (users won't be able to use it anymore to search contents)

Arguments
Name Description
input - SharePointRemoveSearchTabInput! Required Input for the sharePointRemoveSearchTab Mutation

Example

Query
mutation sharePointRemoveSearchTab($input: SharePointRemoveSearchTabInput!) {
  sharePointRemoveSearchTab(input: $input) {
    clientMutationId
    instance {
      ...InstanceFragment
    }
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
      ... on UnconfiguredServiceError {
        ...UnconfiguredServiceErrorFragment
      }
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
    }
  }
}
Variables
{"input": SharePointRemoveSearchTabInput}
Response
{
  "data": {
    "sharePointRemoveSearchTab": {
      "clientMutationId": "xyz789",
      "instance": Instance,
      "errors": [PermissionError]
    }
  }
}

sharePointSearchTabUpdate

Description

Modify an exisiting sharePointSearchTab SharepointSearchTab

Arguments
Name Description
input - SharePointSearchTabUpdateInput! Required Input for the sharePointSearchTabUpdate Mutation

Example

Query
mutation sharePointSearchTabUpdate($input: SharePointSearchTabUpdateInput!) {
  sharePointSearchTabUpdate(input: $input) {
    clientMutationId
    instance {
      ...InstanceFragment
    }
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
      ... on UnconfiguredServiceError {
        ...UnconfiguredServiceErrorFragment
      }
    }
  }
}
Variables
{"input": SharePointSearchTabUpdateInput}
Response
{
  "data": {
    "sharePointSearchTabUpdate": {
      "clientMutationId": "abc123",
      "instance": Instance,
      "errors": [PermissionError]
    }
  }
}

slackActivitiesConfigUpdate

Description

Updates the activities for which a message should be pushed to Slack

Arguments
Name Description
input - SlackActivitiesConfigUpdateInput! Required Input for the slackActivitiesConfigUpdate Mutation

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": "xyz789",
      "instance": Instance,
      "errors": [PermissionError]
    }
  }
}

slackSpacesToChannelRemove

Description

Removes the "Elium space to Slack channel mapping" (SpacesToChannelItem) if it exists

Arguments
Name Description
input - SlackSpacesToChannelRemoveInput! Required Input for the slackSpacesToChannelRemove Mutation

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

Arguments
Name Description
input - SlackSpacesToChannelUpdateInput! Required Input for the slackSpacesToChannelUpdate Mutation

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]
    }
  }
}

smartAssistantCreate

Description

Create a new SmartAssistant require MeActions.smartAssistantsManage to be able to create one.

Response

Returns a SmartAssistantCreatePayload

Arguments
Name Description
input - SmartAssistantCreateInput! Required Input for the smartAssistantCreate Mutation

Example

Query
mutation smartAssistantCreate($input: SmartAssistantCreateInput!) {
  smartAssistantCreate(input: $input) {
    clientMutationId
    errors {
      ... on InvalidInputError {
        ...InvalidInputErrorFragment
      }
      ... on PermissionError {
        ...PermissionErrorFragment
      }
    }
    edge {
      ...SmartAssistantEdgeFragment
    }
    smartAssistant {
      ...SmartAssistantFragment
    }
  }
}
Variables
{"input": SmartAssistantCreateInput}
Response
{
  "data": {
    "smartAssistantCreate": {
      "clientMutationId": "xyz789",
      "errors": [InvalidInputError],
      "edge": SmartAssistantEdge,
      "smartAssistant": SmartAssistant
    }
  }
}

smartAssistantDelete

Description

Delete a SmartAssistant require MeActions.smartAssistantsManage to be able to remove it.

Response

Returns a SmartAssistantDeletePayload

Arguments
Name Description
input - SmartAssistantDeleteInput! Required Input for the smartAssistantDelete Mutation

Example

Query
mutation smartAssistantDelete($input: SmartAssistantDeleteInput!) {
  smartAssistantDelete(input: $input) {
    clientMutationId
    errors {
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
      ... on PermissionError {
        ...PermissionErrorFragment
      }
    }
    deletedId
    instance {
      ...InstanceFragment
    }
  }
}
Variables
{"input": SmartAssistantDeleteInput}
Response
{
  "data": {
    "smartAssistantDelete": {
      "clientMutationId": "xyz789",
      "errors": [ObjectNotFoundError],
      "deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "instance": Instance
    }
  }
}

smartAssistantOrder

Description

Order the list of SmartAssistant require MeActions.smartAssistantsManage

Response

Returns a SmartAssistantOrderPayload

Arguments
Name Description
input - SmartAssistantOrderInput! Required Input for the smartAssistantOrder Mutation

Example

Query
mutation smartAssistantOrder($input: SmartAssistantOrderInput!) {
  smartAssistantOrder(input: $input) {
    clientMutationId
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
    }
    instance {
      ...InstanceFragment
    }
  }
}
Variables
{"input": SmartAssistantOrderInput}
Response
{
  "data": {
    "smartAssistantOrder": {
      "clientMutationId": "abc123",
      "errors": [PermissionError],
      "instance": Instance
    }
  }
}

smartAssistantUpdate

Description

Update a given SmartAssistant require MeActions.smartAssistantsManage to be able to edit one.

Response

Returns a SmartAssistantUpdatePayload

Arguments
Name Description
input - SmartAssistantUpdateInput! Required Input for the smartAssistantUpdate Mutation

Example

Query
mutation smartAssistantUpdate($input: SmartAssistantUpdateInput!) {
  smartAssistantUpdate(input: $input) {
    clientMutationId
    errors {
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
      ... on PermissionError {
        ...PermissionErrorFragment
      }
      ... on InvalidInputError {
        ...InvalidInputErrorFragment
      }
    }
    smartAssistant {
      ...SmartAssistantFragment
    }
  }
}
Variables
{"input": SmartAssistantUpdateInput}
Response
{
  "data": {
    "smartAssistantUpdate": {
      "clientMutationId": "abc123",
      "errors": [ObjectNotFoundError],
      "smartAssistant": SmartAssistant
    }
  }
}

smartConversationArchive

Description

Archive a given SmartConversation

Response

Returns a SmartConversationArchivePayload

Arguments
Name Description
input - SmartConversationArchiveInput! Required Input for the smartConversationArchive Mutation

Example

Query
mutation smartConversationArchive($input: SmartConversationArchiveInput!) {
  smartConversationArchive(input: $input) {
    clientMutationId
    errors {
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
      ... on PermissionError {
        ...PermissionErrorFragment
      }
      ... on InvalidInputError {
        ...InvalidInputErrorFragment
      }
    }
    smartConversation {
      ...SmartConversationFragment
    }
  }
}
Variables
{"input": SmartConversationArchiveInput}
Response
{
  "data": {
    "smartConversationArchive": {
      "clientMutationId": "abc123",
      "errors": [ObjectNotFoundError],
      "smartConversation": SmartConversation
    }
  }
}

smartConversationCreate

Description

Create a new SmartConversation: Sesssion of a conversation with a SmartAssistant

Response

Returns a SmartConversationCreatePayload

Arguments
Name Description
input - SmartConversationCreateInput! Required Input for the smartConversationCreate Mutation

Example

Query
mutation smartConversationCreate($input: SmartConversationCreateInput!) {
  smartConversationCreate(input: $input) {
    clientMutationId
    errors {
      ... on InvalidInputError {
        ...InvalidInputErrorFragment
      }
      ... on PermissionError {
        ...PermissionErrorFragment
      }
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
    }
    smartConversation {
      ...SmartConversationFragment
    }
    edge {
      ...SmartConversationEdgeFragment
    }
  }
}
Variables
{"input": SmartConversationCreateInput}
Response
{
  "data": {
    "smartConversationCreate": {
      "clientMutationId": "xyz789",
      "errors": [InvalidInputError],
      "smartConversation": SmartConversation,
      "edge": SmartConversationEdge
    }
  }
}

smartConversationDelete

Description

Delete a SmartConversation

Response

Returns a SmartConversationDeletePayload

Arguments
Name Description
input - SmartConversationDeleteInput! Required Input for the smartConversationDelete Mutation

Example

Query
mutation smartConversationDelete($input: SmartConversationDeleteInput!) {
  smartConversationDelete(input: $input) {
    clientMutationId
    errors {
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
      ... on PermissionError {
        ...PermissionErrorFragment
      }
    }
    deletedId
    instance {
      ...InstanceFragment
    }
  }
}
Variables
{"input": SmartConversationDeleteInput}
Response
{
  "data": {
    "smartConversationDelete": {
      "clientMutationId": "abc123",
      "errors": [ObjectNotFoundError],
      "deletedId": "eWVhaCByaWdodCBpdCdzIGI2NA==",
      "instance": Instance
    }
  }
}

smartConversationPostMessage

Description

Append Messages to a given SmartConversation

Arguments
Name Description
input - SmartConversationPostMessageInput! Required Input for the smartConversationPostMessage Mutation

Example

Query
mutation smartConversationPostMessage($input: SmartConversationPostMessageInput!) {
  smartConversationPostMessage(input: $input) {
    clientMutationId
    errors {
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
      ... on PermissionError {
        ...PermissionErrorFragment
      }
      ... on InvalidInputError {
        ...InvalidInputErrorFragment
      }
    }
    smartConversation {
      ...SmartConversationFragment
    }
  }
}
Variables
{"input": SmartConversationPostMessageInput}
Response
{
  "data": {
    "smartConversationPostMessage": {
      "clientMutationId": "abc123",
      "errors": [ObjectNotFoundError],
      "smartConversation": SmartConversation
    }
  }
}

smartConversationUpdate

Description

Update a given SmartConversation

Response

Returns a SmartConversationUpdatePayload

Arguments
Name Description
input - SmartConversationUpdateInput! Required Input for the smartConversationUpdate Mutation

Example

Query
mutation smartConversationUpdate($input: SmartConversationUpdateInput!) {
  smartConversationUpdate(input: $input) {
    clientMutationId
    errors {
      ... on ObjectNotFoundError {
        ...ObjectNotFoundErrorFragment
      }
      ... on PermissionError {
        ...PermissionErrorFragment
      }
    }
    smartConversation {
      ...SmartConversationFragment
    }
  }
}
Variables
{"input": SmartConversationUpdateInput}
Response
{
  "data": {
    "smartConversationUpdate": {
      "clientMutationId": "xyz789",
      "errors": [ObjectNotFoundError],
      "smartConversation": SmartConversation
    }
  }
}

smartFeedCreate

Description

Create a new SmartFeed require MeActions.smartFeedsManage to be able to create one.

Response

Returns a SmartFeedCreatePayload

Arguments
Name Description
input - SmartFeedCreateInput! Required Parameter for the smartFeedCreate Mutation

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": "xyz789",
      "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! Required Parameter for the smartFeedDelete Mutation

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! Required Parameter for the smartFeedOrder Mutation

Example

Query
mutation smartFeedOrder($input: SmartFeedOrderInput!) {
  smartFeedOrder(input: $input) {
    clientMutationId
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
    }
    instance {
      ...InstanceFragment
    }
  }
}
Variables
{"input": SmartFeedOrderInput}
Response
{
  "data": {
    "smartFeedOrder": {
      "clientMutationId": "abc123",
      "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! Required Parameter for the smartFeedUpdate Mutation

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! Required Parameter for the spaceAdd Mutation

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! Required Parameter for the spaceAddRequest Mutation

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! Required Parameter for the spaceDelete Mutation

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! Required Parameter for the spaceFavorite Mutation

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! Required Parameter for the spaceGroupAdd Mutation

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! Required Parameter for the spaceGroupDelete Mutation

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! Required Parameter for the spaceGroupOrder Mutation

Example

Query
mutation spaceGroupOrder($input: SpaceGroupOrderInput!) {
  spaceGroupOrder(input: $input) {
    clientMutationId
    errors {
      ... on PermissionError {
        ...PermissionErrorFragment
      }
    }
    spaceGroups {
      ...SpaceGroupFragment
    }
  }
}
Variables
{"input": SpaceGroupOrderInput}
Response
{
  "data": {
    "spaceGroupOrder": {
      "clientMutationId": "xyz789",
      "errors": [PermissionError],
      "spaceGroups": [SpaceGroup]
    }
  }
}

spaceGroupUpdate

Description

Update a given SpaceGroup's settings and configuration

Response

Returns a SpaceGroupUpdatePayload

Arguments
Name Description
input - SpaceGroupUpdateInput! Required Parameter for the spaceGroupUpdate Mutation

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! Required Parameter for the spaceJoin Mutation

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! Required Parameter for the spaceLeave Mutation

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! Required Parameter for the spaceMemberAdd Mutation

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": false,
      "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! Required Parameter for the spaceMemberDelete Mutation

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! Required Parameter for the spaceMemberRole Mutation

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": "xyz789",
      "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! Required Parameter for the spaceOrder Mutation

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": "abc123",
      "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! Required Parameter for the spaceRequest Mutation

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": "xyz789",
      "errors": [ObjectNotFoundError],
      "space": Space
    }
  }
}

spaceRequestAccept

Description

Accept a requested space creation (need me.action.admin)

Response

Returns a SpaceRequestAcceptPayload

Arguments
Name Description
input - SpaceRequestAcceptInput! Required Parameter for the spaceRequestAccept Mutation

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

Description

Change A given space Status to closed or open

Response

Returns a SpaceStatusPayload

Arguments
Name Description
input - SpaceStatusInput! Required Parameter for the spaceStatus Mutation

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": "xyz789",
      "space": Space,
      "errors": [ObjectNotFoundError]
    }
  }
}

spaceTabDelete

Description

Delete a SpaceTab of a given space