LaunchNotes API Documentation
Learn how to use the LaunchNotes API to programmatically manage your LaunchNotes account.
API Authentication
Creating an API token
To interact with our API, you'll need to generate an API token. This can be found under Settings > API & Embed in the LaunchNotes admin navbar, and selecting the create API Token button.
Read-only Public tokens
This API user can only read in public Announcements. Perfect for embedding published Announcements into your web app using our pop-over embed or the API itself.Management API tokens
Management API tokens provide read and write access to your project. Their level of permission is that of a Contributor, so they can create and update Announcements. These tokens should never be shared publicly and are suitable for server-side use cases where you might want to automate the creation of content.
The GraphQL Endpoint
https://app.launchnotes.io/graphql
The endpoint is the same for all operations, regardless of token type.
Using an API token
You must provide an API token as a Bearer token for every request to the API.
For example:
curl 'H "Authorization: Bearer public_QKHLUeWw6HxyE5cq9nujHqqX" \
-X POST -d " \
{ \
\"query\": \"query { viewer { id }}\" \
} \
" https://app.launchnotes.io/graphql
More information about our API
Terms of Service
API Endpoints
https://app.launchnotes.io/graphqlQueries
announcement
Response
Returns an Announcement!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query announcement($id: ID!) {
announcement(id: $id) {
archived
author
authorWithFallback
categories {
...CategoryFragment
}
changeTypes {
...ChangeTypeConnectionFragment
}
connectedSources {
...ConnectedSourceConnectionFragment
}
content
contentGenerators {
...ContentGeneratorConnectionFragment
}
contentHtml
contentPlainText
contentType
createdAt
deactivatedAt
description
descriptionWithFallback
doNotIndex
emailAnalytics {
...EmailAnalyticsObjectFragment
}
excerpt
excerptWithFallback
exportFeedbacks {
...FeedbackFragment
}
externalContentLinks {
...ExternalContentLinkFragment
}
feedbackHappyCount
feedbackMehCount
feedbackSadCount
feedbacks {
...FeedbackConnectionFragment
}
hasPendingContentGenerators
headline
heroImage {
...ImageFragment
}
id
inPublishedDigest
name
notificationsExcerptOnly
notificationsSent
privatePermalink
publicPermalink
publishedAt
scheduledAt
scheduledAtTimezone
shareImage {
...ImageFragment
}
shouldNotifyPageSubscribers
slackChannelCount
slackChannelCounts
slackChannels {
...ChannelConnectionFragment
}
slackMessage
slug
state
subjectLine
subjectLineWithFallback
subscriberCounts
subscribers {
...ProjectSubscriptionConnectionFragment
}
template {
...TemplateFragment
}
title
titleWithFallback
totalSubscriberCounts
updatedAt
videoAsset {
...VideoAssetFragment
}
viewerAnalytics {
...ViewerAnalyticsObjectFragment
}
workItems {
...WorkItemConnectionFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"announcement": {
"archived": false,
"author": "xyz789",
"authorWithFallback": "abc123",
"categories": [Category],
"changeTypes": ChangeTypeConnection,
"connectedSources": ConnectedSourceConnection,
"content": "xyz789",
"contentGenerators": ContentGeneratorConnection,
"contentHtml": "abc123",
"contentPlainText": "abc123",
"contentType": "xyz789",
"createdAt": ISO8601DateTime,
"deactivatedAt": ISO8601DateTime,
"description": "abc123",
"descriptionWithFallback": "xyz789",
"doNotIndex": false,
"emailAnalytics": EmailAnalyticsObject,
"excerpt": "xyz789",
"excerptWithFallback": "xyz789",
"exportFeedbacks": [Feedback],
"externalContentLinks": [ExternalContentLink],
"feedbackHappyCount": 987,
"feedbackMehCount": 123,
"feedbackSadCount": 123,
"feedbacks": FeedbackConnection,
"hasPendingContentGenerators": true,
"headline": "xyz789",
"heroImage": Image,
"id": 4,
"inPublishedDigest": true,
"name": "xyz789",
"notificationsExcerptOnly": false,
"notificationsSent": 987,
"privatePermalink": "xyz789",
"publicPermalink": "xyz789",
"publishedAt": ISO8601DateTime,
"scheduledAt": ISO8601DateTime,
"scheduledAtTimezone": "xyz789",
"shareImage": Image,
"shouldNotifyPageSubscribers": true,
"slackChannelCount": 987,
"slackChannelCounts": 123,
"slackChannels": ChannelConnection,
"slackMessage": "xyz789",
"slug": "xyz789",
"state": "archived",
"subjectLine": "abc123",
"subjectLineWithFallback": "abc123",
"subscriberCounts": 987,
"subscribers": ProjectSubscriptionConnection,
"template": Template,
"title": "xyz789",
"titleWithFallback": "xyz789",
"totalSubscriberCounts": 123,
"updatedAt": ISO8601DateTime,
"videoAsset": VideoAsset,
"viewerAnalytics": ViewerAnalyticsObject,
"workItems": WorkItemConnection
}
}
}
announcementDigest
Response
Returns an AnnouncementDigest!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query announcementDigest($id: ID!) {
announcementDigest(id: $id) {
announcements {
...AnnouncementConnectionFragment
}
categories {
...CategoryFragment
}
content
contentHtml
contentPlainText
contentType
createdAt
deactivatedAt
emailClickedThroughCount
emailOpenedCount
emailSentCount
emailSubscriberCount
id
labels {
...ChangeTypeFragment
}
order
publishedAt
slackChannelClickedThroughCount
slackChannelCount
slackChannelSentCount
slackChannels {
...ChannelFragment
}
slackSubscriberClickedThroughCount
slackSubscriberCount
slackSubscriberSentCount
state
subjectLine
subscribers {
...ProjectSubscriptionConnectionFragment
}
title
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"announcementDigest": {
"announcements": AnnouncementConnection,
"categories": [Category],
"content": "abc123",
"contentHtml": "abc123",
"contentPlainText": "xyz789",
"contentType": "abc123",
"createdAt": ISO8601DateTime,
"deactivatedAt": ISO8601DateTime,
"emailClickedThroughCount": 123,
"emailOpenedCount": 987,
"emailSentCount": 987,
"emailSubscriberCount": 123,
"id": 4,
"labels": [ChangeType],
"order": ["abc123"],
"publishedAt": ISO8601DateTime,
"slackChannelClickedThroughCount": 123,
"slackChannelCount": 123,
"slackChannelSentCount": 987,
"slackChannels": [Channel],
"slackSubscriberClickedThroughCount": 123,
"slackSubscriberCount": 987,
"slackSubscriberSentCount": 987,
"state": "draft",
"subjectLine": "abc123",
"subscribers": ProjectSubscriptionConnection,
"title": "xyz789",
"updatedAt": ISO8601DateTime
}
}
}
feedback
Example
Query
query feedback($id: ID!) {
feedback(id: $id) {
affectedCustomer {
...SubscriberFragment
}
affectedCustomerEmail
archived
attributes {
...AttributeFragment
}
canFollowUp
canUseTestimonial
content
createdAt
feedbackable {
...FeedbackableFragment
}
id
idea {
...IdeaFragment
}
importance
notes
project {
...ProjectFragment
}
reaction
reporter {
...UserFragment
}
sentimentMagnitude
sentimentScore
starred
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"feedback": {
"affectedCustomer": Subscriber,
"affectedCustomerEmail": "abc123",
"archived": false,
"attributes": [Attribute],
"canFollowUp": true,
"canUseTestimonial": false,
"content": "abc123",
"createdAt": ISO8601DateTime,
"feedbackable": Feedbackable,
"id": 4,
"idea": Idea,
"importance": "low",
"notes": "abc123",
"project": Project,
"reaction": "happy",
"reporter": User,
"sentimentMagnitude": 123.45,
"sentimentScore": 987.65,
"starred": true,
"updatedAt": ISO8601DateTime
}
}
}
idea
Example
Query
query idea($id: ID!) {
idea(id: $id) {
archived
categories {
...CategoryConnectionFragment
}
createdAt
deactivatedAt
emailPromotionCount
exportFeedbacks {
...FeedbackFragment
}
feedbackCount
feedbackHappyCount
feedbackMehCount
feedbackSadCount
feedbacks {
...FeedbackConnectionFragment
}
id
ideaVotesCount
lastFeedback
latestWorkItemId
name
notes
privatePermalink
project {
...ProjectFragment
}
publicPermalink
published
updatedAt
votes {
...VoteConnectionFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"idea": {
"archived": false,
"categories": CategoryConnection,
"createdAt": ISO8601DateTime,
"deactivatedAt": ISO8601DateTime,
"emailPromotionCount": 987,
"exportFeedbacks": [Feedback],
"feedbackCount": 987,
"feedbackHappyCount": 987,
"feedbackMehCount": 123,
"feedbackSadCount": 123,
"feedbacks": FeedbackConnection,
"id": "4",
"ideaVotesCount": 123,
"lastFeedback": ISO8601DateTime,
"latestWorkItemId": "abc123",
"name": "abc123",
"notes": "abc123",
"privatePermalink": "abc123",
"project": Project,
"publicPermalink": "abc123",
"published": false,
"updatedAt": ISO8601DateTime,
"votes": VoteConnection
}
}
}
node
Description
Fetches an object given its ID
nodes
Description
Fetches a list of objects given a list of IDs
project
Description
The project API entry point
Example
Query
query project($id: ID!) {
project(id: $id) {
allowedDomains
announcementDigests {
...AnnouncementDigestConnectionFragment
}
announcements {
...AnnouncementConnectionFragment
}
apiToken {
...ApiTokenFragment
}
apiTokens {
...ApiTokenConnectionFragment
}
attributeDefinitions {
...AttributeDefinitionConnectionFragment
}
audienceDomain {
...AudienceDomainFragment
}
audienceDomains {
...AudienceDomainConnectionFragment
}
author
autosubscribeNewUsers
categories {
...CategoryConnectionFragment
}
changeTypes {
...ChangeTypeConnectionFragment
}
cohort {
...CohortFragment
}
cohorts {
...CohortConnectionFragment
}
colorTheme
connectedJiraProjects
createdAt
crmDataLastSync
customCss
customFooter
customHead
customHeader
customIndexHero
defaultNotificationSetting
defaultPrompt
defaultWorkItemsDisplayTimeline
density
description
editable
emailProjectSubscription {
...ProjectSubscriptionFragment
}
emailSettings {
...MailAppSettingFragment
}
emailSubscription {
...SubscriptionFragment
}
embedApps {
...EmbedAppFragment
}
emptyFieldImage {
...ImageFragment
}
eventTypes {
...EventTypeConnectionFragment
}
events {
...EventConnectionFragment
}
exportFeedbacks {
...FeedbackFragment
}
exportSubscribers {
...SubscriberConnectionFragment
}
favicon {
...ImageFragment
}
feedbackEnabled
feedbackForwardEmails
feedbackHappyCount
feedbackMehCount
feedbackSadCount
feedbackViaEmailEnabled
feedbackViaSlackEnabled
feedbacks {
...FeedbackConnectionFragment
}
fiscalYearOffset
grayColor
hasPublishedIdea
heading
hideNotificationContent
id
ideas {
...IdeaConnectionFragment
}
ideasDisclaimer
ideasDisclaimerEnabled
ideasEnabled
ideasName
lightGrayColor
logo {
...ImageFragment
}
marketplaceTemplates {
...MarketplaceTemplateConnectionFragment
}
maxTeamMembers
name
newSubscriptionsThisMonth
noindex
offWhiteColor
onboardingTasks {
...OnboardingTasksFragment
}
organization {
...OrganizationFragment
}
outboundWebhooks {
...OutboundWebhookFragment
}
primaryColor
primaryTextColor
privacyPolicyUrl
projectAdmins {
...UserFragment
}
projectApps {
...ProjectAppConnectionFragment
}
projectSubscription {
...ProjectSubscriptionFragment
}
projectSubscriptionByEmail {
...ProjectSubscriptionFragment
}
projectSubscriptions {
...ProjectSubscriptionConnectionFragment
}
projectUsers {
...UserConnectionFragment
}
projectView {
...ProjectViewFragment
}
projectViews {
...ProjectViewConnectionFragment
}
publicPageUrl
publicStageDescriptionsEnabled
published
referralSource
restricted
roadmapDisclaimer
roadmapDisclaimerEnabled
roadmapEnabled
roadmapMoveUpdatesEnabled
roadmapName
roadmapWatchedStages
rollup {
...RollupFragment
}
rssFeedEnabled
rssFeedPrivate
rssFeedUrl
rssSecretKey
sandbox
secondaryColor
secondaryTextColor
secureConnectionSettings {
...SecureConnectionSettingsFragment
}
secured
shareImage {
...ImageFragment
}
shareImageAltText
showToc
slackAuthenticationUrl
slackProjectSubscription {
...ProjectSubscriptionFragment
}
slackSubscription {
...SubscriptionFragment
}
slackWorkspaces {
...WorkspaceFragment
}
slug
stages {
...StageConnectionFragment
}
subheading
subscriberReportEnabled
subscribers {
...SubscriberConnectionFragment
}
subscriptionByEmail {
...SubscriptionFragment
}
subscriptions {
...SubscriptionConnectionFragment
}
supportingPalette
templates {
...TemplateConnectionFragment
}
termsAndConditionsUrl
title
totalConfirmedSubscriptions
totalUnsubscribedSubscriptions
twitterUsername
unreadCount
updatedAt
vaultConnections
voteCountDisplay
votingEnabled
whiteColor
workItems {
...WorkItemConnectionFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"project": {
"allowedDomains": ["xyz789"],
"announcementDigests": AnnouncementDigestConnection,
"announcements": AnnouncementConnection,
"apiToken": ApiToken,
"apiTokens": ApiTokenConnection,
"attributeDefinitions": AttributeDefinitionConnection,
"audienceDomain": AudienceDomain,
"audienceDomains": AudienceDomainConnection,
"author": "xyz789",
"autosubscribeNewUsers": false,
"categories": CategoryConnection,
"changeTypes": ChangeTypeConnection,
"cohort": Cohort,
"cohorts": CohortConnection,
"colorTheme": "abc123",
"connectedJiraProjects": ["abc123"],
"createdAt": ISO8601DateTime,
"crmDataLastSync": ISO8601DateTime,
"customCss": "xyz789",
"customFooter": "xyz789",
"customHead": "abc123",
"customHeader": "xyz789",
"customIndexHero": "abc123",
"defaultNotificationSetting": true,
"defaultPrompt": "abc123",
"defaultWorkItemsDisplayTimeline": true,
"density": "abc123",
"description": "xyz789",
"editable": true,
"emailProjectSubscription": ProjectSubscription,
"emailSettings": MailAppSetting,
"emailSubscription": Subscription,
"embedApps": [EmbedApp],
"emptyFieldImage": Image,
"eventTypes": EventTypeConnection,
"events": EventConnection,
"exportFeedbacks": [Feedback],
"exportSubscribers": SubscriberConnection,
"favicon": Image,
"feedbackEnabled": false,
"feedbackForwardEmails": ["xyz789"],
"feedbackHappyCount": 987,
"feedbackMehCount": 987,
"feedbackSadCount": 987,
"feedbackViaEmailEnabled": true,
"feedbackViaSlackEnabled": true,
"feedbacks": FeedbackConnection,
"fiscalYearOffset": 123,
"grayColor": "abc123",
"hasPublishedIdea": true,
"heading": "abc123",
"hideNotificationContent": true,
"id": "4",
"ideas": IdeaConnection,
"ideasDisclaimer": "abc123",
"ideasDisclaimerEnabled": false,
"ideasEnabled": true,
"ideasName": "abc123",
"lightGrayColor": "abc123",
"logo": Image,
"marketplaceTemplates": MarketplaceTemplateConnection,
"maxTeamMembers": 987,
"name": "abc123",
"newSubscriptionsThisMonth": 123,
"noindex": true,
"offWhiteColor": "xyz789",
"onboardingTasks": OnboardingTasks,
"organization": Organization,
"outboundWebhooks": [OutboundWebhook],
"primaryColor": "xyz789",
"primaryTextColor": "xyz789",
"privacyPolicyUrl": "abc123",
"projectAdmins": [User],
"projectApps": ProjectAppConnection,
"projectSubscription": ProjectSubscription,
"projectSubscriptionByEmail": ProjectSubscription,
"projectSubscriptions": ProjectSubscriptionConnection,
"projectUsers": UserConnection,
"projectView": ProjectView,
"projectViews": ProjectViewConnection,
"publicPageUrl": "xyz789",
"publicStageDescriptionsEnabled": true,
"published": true,
"referralSource": "xyz789",
"restricted": false,
"roadmapDisclaimer": "xyz789",
"roadmapDisclaimerEnabled": false,
"roadmapEnabled": false,
"roadmapMoveUpdatesEnabled": true,
"roadmapName": "xyz789",
"roadmapWatchedStages": ["xyz789"],
"rollup": Rollup,
"rssFeedEnabled": false,
"rssFeedPrivate": false,
"rssFeedUrl": "xyz789",
"rssSecretKey": "xyz789",
"sandbox": true,
"secondaryColor": "abc123",
"secondaryTextColor": "abc123",
"secureConnectionSettings": SecureConnectionSettings,
"secured": false,
"shareImage": Image,
"shareImageAltText": "abc123",
"showToc": false,
"slackAuthenticationUrl": "abc123",
"slackProjectSubscription": ProjectSubscription,
"slackSubscription": Subscription,
"slackWorkspaces": [Workspace],
"slug": "abc123",
"stages": StageConnection,
"subheading": "xyz789",
"subscriberReportEnabled": true,
"subscribers": SubscriberConnection,
"subscriptionByEmail": Subscription,
"subscriptions": SubscriptionConnection,
"supportingPalette": "abc123",
"templates": TemplateConnection,
"termsAndConditionsUrl": "xyz789",
"title": "xyz789",
"totalConfirmedSubscriptions": 123,
"totalUnsubscribedSubscriptions": 123,
"twitterUsername": "abc123",
"unreadCount": 987,
"updatedAt": ISO8601DateTime,
"vaultConnections": ["xyz789"],
"voteCountDisplay": "abc123",
"votingEnabled": true,
"whiteColor": "xyz789",
"workItems": WorkItemConnection
}
}
}
projectSearch
Response
Returns [SearchResult!]!
Example
Query
query projectSearch(
$projectId: ID!,
$searchTerm: String!,
$limit: Int
) {
projectSearch(
projectId: $projectId,
searchTerm: $searchTerm,
limit: $limit
) {
... on Announcement {
...AnnouncementFragment
}
... on AudienceDomain {
...AudienceDomainFragment
}
... on Idea {
...IdeaFragment
}
... on Subscriber {
...SubscriberFragment
}
... on WorkItem {
...WorkItemFragment
}
}
}
Variables
{
"projectId": "4",
"searchTerm": "abc123",
"limit": 123
}
Response
{"data": {"projectSearch": [Announcement]}}
session
Description
The session API entry point - this is for internal use only (do not build your integration using this)
Response
Returns a User!
Example
Query
query session {
session {
avatarColor
avatarImage {
...ImageFragment
}
confirmedAt
createdAt
defaultProject {
...ProjectFragment
}
displayName
email
firstName
greatestPermission
id
initials
lastName
name
organization {
...OrganizationFragment
}
organizations {
...OrganizationFragment
}
permissions
project {
...ProjectFragment
}
projects {
...ProjectConnectionFragment
}
referralSource
role
status
subscriptions {
...SubscriptionFragment
}
updatedAt
}
}
Response
{
"data": {
"session": {
"avatarColor": "xyz789",
"avatarImage": Image,
"confirmedAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"defaultProject": Project,
"displayName": "xyz789",
"email": "abc123",
"firstName": "xyz789",
"greatestPermission": "xyz789",
"id": "4",
"initials": "xyz789",
"lastName": "abc123",
"name": "abc123",
"organization": Organization,
"organizations": [Organization],
"permissions": ["abc123"],
"project": Project,
"projects": ProjectConnection,
"referralSource": "search_engine",
"role": "all",
"status": "abc123",
"subscriptions": [Subscription],
"updatedAt": ISO8601DateTime
}
}
}
template
Example
Query
query template($id: ID!) {
template(id: $id) {
categories {
...CategoryFragment
}
content
contentHtml
contentPlainText
contentType
createdAt
description
excerpt
excerptWithFallback
headline
heroImage {
...ImageFragment
}
id
name
project {
...ProjectFragment
}
updatedAt
workItems {
...WorkItemConnectionFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"template": {
"categories": [Category],
"content": "xyz789",
"contentHtml": "abc123",
"contentPlainText": "abc123",
"contentType": "abc123",
"createdAt": ISO8601DateTime,
"description": "abc123",
"excerpt": "abc123",
"excerptWithFallback": "xyz789",
"headline": "abc123",
"heroImage": Image,
"id": "4",
"name": "abc123",
"project": Project,
"updatedAt": ISO8601DateTime,
"workItems": WorkItemConnection
}
}
}
viewer
Description
The published and management API entry point
Response
Returns an ApiUser!
Example
Query
query viewer {
viewer {
createdAt
email
id
name
organization {
...OrganizationFragment
}
project {
...ProjectFragment
}
projects {
...ProjectConnectionFragment
}
updatedAt
}
}
Response
{
"data": {
"viewer": {
"createdAt": ISO8601DateTime,
"email": "xyz789",
"id": "4",
"name": "abc123",
"organization": Organization,
"project": Project,
"projects": ProjectConnection,
"updatedAt": ISO8601DateTime
}
}
}
workItem
Example
Query
query workItem($id: ID!) {
workItem(id: $id) {
announcements {
...AnnouncementConnectionFragment
}
archived
categories {
...CategoryFragment
}
changeTypes {
...ChangeTypeConnectionFragment
}
connectedSources {
...ConnectedSourceConnectionFragment
}
content
contentHtml
contentPlainText
contentType
createdAt
deactivatedAt
displayTimeline
events {
...EventConnectionFragment
}
excerptWithFallback
exportFeedbacks {
...FeedbackFragment
}
exportSubscribers {
...SubscriberConnectionFragment
}
externalContentLinks {
...ExternalContentLinkFragment
}
feedbackHappyCount
feedbackMehCount
feedbackSadCount
feedbacks {
...FeedbackConnectionFragment
}
heroImage {
...ImageFragment
}
id
ideas {
...IdeaFragment
}
members {
...UserFragment
}
name
owner {
...UserFragment
}
position
privatePermalink
projectSubscription {
...ProjectSubscriptionFragment
}
projectSubscriptionByEmail {
...ProjectSubscriptionFragment
}
projectSubscriptions {
...ProjectSubscriptionConnectionFragment
}
projectedAt
projectedAtFormat
publicPermalink
publishedAt
roadmapUpdates {
...RoadmapUpdateFragment
}
showOnPublicRoadmap
slug
stage {
...StageFragment
}
stageId
state
subscribers {
...SubscriberConnectionFragment
}
subscriptions {
...SubscriptionConnectionFragment
}
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"workItem": {
"announcements": AnnouncementConnection,
"archived": false,
"categories": [Category],
"changeTypes": ChangeTypeConnection,
"connectedSources": ConnectedSourceConnection,
"content": "abc123",
"contentHtml": "abc123",
"contentPlainText": "abc123",
"contentType": "xyz789",
"createdAt": ISO8601DateTime,
"deactivatedAt": ISO8601DateTime,
"displayTimeline": true,
"events": EventConnection,
"excerptWithFallback": "abc123",
"exportFeedbacks": [Feedback],
"exportSubscribers": SubscriberConnection,
"externalContentLinks": [ExternalContentLink],
"feedbackHappyCount": 987,
"feedbackMehCount": 987,
"feedbackSadCount": 987,
"feedbacks": FeedbackConnection,
"heroImage": Image,
"id": "4",
"ideas": [Idea],
"members": [User],
"name": "xyz789",
"owner": User,
"position": 123,
"privatePermalink": "xyz789",
"projectSubscription": ProjectSubscription,
"projectSubscriptionByEmail": ProjectSubscription,
"projectSubscriptions": ProjectSubscriptionConnection,
"projectedAt": "abc123",
"projectedAtFormat": "xyz789",
"publicPermalink": "abc123",
"publishedAt": ISO8601DateTime,
"roadmapUpdates": [RoadmapUpdate],
"showOnPublicRoadmap": true,
"slug": "xyz789",
"stage": Stage,
"stageId": "4",
"state": "draft",
"subscribers": SubscriberConnection,
"subscriptions": SubscriptionConnection,
"updatedAt": ISO8601DateTime
}
}
}
Mutations
archiveAnnouncement
Response
Returns an ArchiveAnnouncementPayload
Arguments
| Name | Description |
|---|---|
input - ArchiveAnnouncementInput!
|
Parameters for ArchiveAnnouncement |
Example
Query
mutation archiveAnnouncement($input: ArchiveAnnouncementInput!) {
archiveAnnouncement(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": ArchiveAnnouncementInput}
Response
{
"data": {
"archiveAnnouncement": {
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
archiveFeedback
Response
Returns an ArchiveFeedbackPayload
Arguments
| Name | Description |
|---|---|
input - ArchiveFeedbackInput!
|
Parameters for ArchiveFeedback |
Example
Query
mutation archiveFeedback($input: ArchiveFeedbackInput!) {
archiveFeedback(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
feedback {
...FeedbackFragment
}
}
}
Variables
{"input": ArchiveFeedbackInput}
Response
{
"data": {
"archiveFeedback": {
"clientMutationId": "abc123",
"errors": [UserError],
"feedback": Feedback
}
}
}
archiveFeedbacks
Response
Returns an ArchiveFeedbacksPayload
Arguments
| Name | Description |
|---|---|
input - ArchiveFeedbacksInput!
|
Parameters for ArchiveFeedbacks |
Example
Query
mutation archiveFeedbacks($input: ArchiveFeedbacksInput!) {
archiveFeedbacks(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
feedbacks {
...FeedbackFragment
}
}
}
Variables
{"input": ArchiveFeedbacksInput}
Response
{
"data": {
"archiveFeedbacks": {
"clientMutationId": "xyz789",
"errors": [UserError],
"feedbacks": [Feedback]
}
}
}
archiveIdeas
Response
Returns an ArchiveIdeasPayload
Arguments
| Name | Description |
|---|---|
input - ArchiveIdeasInput!
|
Parameters for ArchiveIdeas |
Example
Query
mutation archiveIdeas($input: ArchiveIdeasInput!) {
archiveIdeas(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
ideas {
...IdeaFragment
}
}
}
Variables
{"input": ArchiveIdeasInput}
Response
{
"data": {
"archiveIdeas": {
"clientMutationId": "abc123",
"errors": [UserError],
"ideas": [Idea]
}
}
}
archiveProject
Response
Returns an ArchiveProjectPayload
Arguments
| Name | Description |
|---|---|
input - ArchiveProjectInput!
|
Parameters for ArchiveProject |
Example
Query
mutation archiveProject($input: ArchiveProjectInput!) {
archiveProject(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"input": ArchiveProjectInput}
Response
{
"data": {
"archiveProject": {
"clientMutationId": "xyz789",
"errors": [UserError],
"project": Project
}
}
}
archiveStage
Response
Returns an ArchiveStagePayload
Arguments
| Name | Description |
|---|---|
input - ArchiveStageInput!
|
Parameters for ArchiveStage |
Example
Query
mutation archiveStage($input: ArchiveStageInput!) {
archiveStage(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
stage {
...StageFragment
}
}
}
Variables
{"input": ArchiveStageInput}
Response
{
"data": {
"archiveStage": {
"clientMutationId": "abc123",
"errors": [UserError],
"stage": Stage
}
}
}
archiveTemplate
Response
Returns an ArchiveTemplatePayload
Arguments
| Name | Description |
|---|---|
input - ArchiveTemplateInput!
|
Parameters for ArchiveTemplate |
Example
Query
mutation archiveTemplate($input: ArchiveTemplateInput!) {
archiveTemplate(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
template {
...TemplateFragment
}
}
}
Variables
{"input": ArchiveTemplateInput}
Response
{
"data": {
"archiveTemplate": {
"clientMutationId": "abc123",
"errors": [UserError],
"template": Template
}
}
}
archiveWorkItem
Response
Returns an ArchiveWorkItemPayload
Arguments
| Name | Description |
|---|---|
input - ArchiveWorkItemInput!
|
Parameters for ArchiveWorkItem |
Example
Query
mutation archiveWorkItem($input: ArchiveWorkItemInput!) {
archiveWorkItem(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
workItem {
...WorkItemFragment
}
}
}
Variables
{"input": ArchiveWorkItemInput}
Response
{
"data": {
"archiveWorkItem": {
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
}
}
confirmProjectSubscription
Description
Confirms a project subscription
Response
Returns a ConfirmProjectSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input - ConfirmProjectSubscriptionInput!
|
Parameters for ConfirmProjectSubscription |
Example
Query
mutation confirmProjectSubscription($input: ConfirmProjectSubscriptionInput!) {
confirmProjectSubscription(input: $input) {
clientMutationId
projectSubscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": ConfirmProjectSubscriptionInput}
Response
{
"data": {
"confirmProjectSubscription": {
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscription
}
}
}
confirmSubscribers
Use confirmProjectSubscription instead
Response
Returns a ConfirmSubscribersPayload
Arguments
| Name | Description |
|---|---|
input - ConfirmSubscribersInput!
|
Parameters for ConfirmSubscribers |
Example
Query
mutation confirmSubscribers($input: ConfirmSubscribersInput!) {
confirmSubscribers(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
subscriberIds
}
}
Variables
{"input": ConfirmSubscribersInput}
Response
{
"data": {
"confirmSubscribers": {
"clientMutationId": "abc123",
"errors": [UserError],
"subscriberIds": ["4"]
}
}
}
copyAnnouncementToProject
Response
Returns a CopyAnnouncementToProjectPayload
Arguments
| Name | Description |
|---|---|
input - CopyAnnouncementToProjectInput!
|
Parameters for CopyAnnouncementToProject |
Example
Query
mutation copyAnnouncementToProject($input: CopyAnnouncementToProjectInput!) {
copyAnnouncementToProject(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
targetProject {
...ProjectFragment
}
}
}
Variables
{"input": CopyAnnouncementToProjectInput}
Response
{
"data": {
"copyAnnouncementToProject": {
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError],
"targetProject": Project
}
}
}
createAiAnnouncement
Response
Returns a CreateAiAnnouncementPayload
Arguments
| Name | Description |
|---|---|
input - CreateAiAnnouncementInput!
|
Parameters for CreateAiAnnouncement |
Example
Query
mutation createAiAnnouncement($input: CreateAiAnnouncementInput!) {
createAiAnnouncement(input: $input) {
announcementId
clientMutationId
}
}
Variables
{"input": CreateAiAnnouncementInput}
Response
{
"data": {
"createAiAnnouncement": {
"announcementId": 4,
"clientMutationId": "abc123"
}
}
}
createAnnouncement
Response
Returns a CreateAnnouncementPayload
Arguments
| Name | Description |
|---|---|
input - CreateAnnouncementInput!
|
Parameters for CreateAnnouncement |
Example
Query
mutation createAnnouncement($input: CreateAnnouncementInput!) {
createAnnouncement(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": CreateAnnouncementInput}
Response
{
"data": {
"createAnnouncement": {
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
createApiToken
Response
Returns a CreateApiTokenPayload
Arguments
| Name | Description |
|---|---|
input - CreateApiTokenInput!
|
Parameters for CreateApiToken |
Example
Query
mutation createApiToken($input: CreateApiTokenInput!) {
createApiToken(input: $input) {
apiToken {
...ApiTokenFragment
}
clientMutationId
errors
}
}
Variables
{"input": CreateApiTokenInput}
Response
{
"data": {
"createApiToken": {
"apiToken": ApiToken,
"clientMutationId": "xyz789",
"errors": ["abc123"]
}
}
}
createAttributeDefinition
Response
Returns a CreateAttributeDefinitionPayload
Arguments
| Name | Description |
|---|---|
input - CreateAttributeDefinitionInput!
|
Parameters for CreateAttributeDefinition |
Example
Query
mutation createAttributeDefinition($input: CreateAttributeDefinitionInput!) {
createAttributeDefinition(input: $input) {
attributeDefinition {
...AttributeDefinitionFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": CreateAttributeDefinitionInput}
Response
{
"data": {
"createAttributeDefinition": {
"attributeDefinition": AttributeDefinition,
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
createCategory
Response
Returns a CreateCategoryPayload
Arguments
| Name | Description |
|---|---|
input - CreateCategoryInput!
|
Parameters for CreateCategory |
Example
Query
mutation createCategory($input: CreateCategoryInput!) {
createCategory(input: $input) {
category {
...CategoryFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": CreateCategoryInput}
Response
{
"data": {
"createCategory": {
"category": Category,
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
createChangeType
Description
Create a new change type. Change types are called Labels in the management portal
Response
Returns a CreateChangePayload
Arguments
| Name | Description |
|---|---|
input - CreateChangeInput!
|
Parameters for CreateChange |
Example
Query
mutation createChangeType($input: CreateChangeInput!) {
createChangeType(input: $input) {
changeType {
...ChangeTypeFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": CreateChangeInput}
Response
{
"data": {
"createChangeType": {
"changeType": ChangeType,
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
createDirectUpload
Response
Returns a CreateDirectUploadPayload
Arguments
| Name | Description |
|---|---|
input - CreateDirectUploadInput!
|
Parameters for CreateDirectUpload |
Example
Query
mutation createDirectUpload($input: CreateDirectUploadInput!) {
createDirectUpload(input: $input) {
blob {
...BlobFragment
}
clientMutationId
errors
}
}
Variables
{"input": CreateDirectUploadInput}
Response
{
"data": {
"createDirectUpload": {
"blob": Blob,
"clientMutationId": "abc123",
"errors": ["abc123"]
}
}
}
createExternalContentLink
Response
Returns a CreateExternalContentLinkPayload
Arguments
| Name | Description |
|---|---|
input - CreateExternalContentLinkInput!
|
Parameters for CreateExternalContentLink |
Example
Query
mutation createExternalContentLink($input: CreateExternalContentLinkInput!) {
createExternalContentLink(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
stage {
...StageFragment
}
}
}
Variables
{"input": CreateExternalContentLinkInput}
Response
{
"data": {
"createExternalContentLink": {
"clientMutationId": "xyz789",
"errors": [UserError],
"stage": Stage
}
}
}
createFeedback
Response
Returns a CreateFeedbackPayload
Arguments
| Name | Description |
|---|---|
input - CreateFeedbackInput!
|
Parameters for CreateFeedback |
Example
Query
mutation createFeedback($input: CreateFeedbackInput!) {
createFeedback(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
feedback {
...FeedbackFragment
}
}
}
Variables
{"input": CreateFeedbackInput}
Response
{
"data": {
"createFeedback": {
"clientMutationId": "abc123",
"errors": [UserError],
"feedback": Feedback
}
}
}
createIdea
Description
Attributes for creating an idea
Response
Returns a CreateIdeaPayload
Arguments
| Name | Description |
|---|---|
input - CreateIdeaInput!
|
Parameters for CreateIdea |
Example
Query
mutation createIdea($input: CreateIdeaInput!) {
createIdea(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
idea {
...IdeaFragment
}
}
}
Variables
{"input": CreateIdeaInput}
Response
{
"data": {
"createIdea": {
"clientMutationId": "xyz789",
"errors": [UserError],
"idea": Idea
}
}
}
createOrganizationProfile
Description
Creates a new create_organization_profile
Response
Returns a CreateOrganizationProfilePayload
Arguments
| Name | Description |
|---|---|
input - CreateOrganizationProfileInput!
|
Parameters for CreateOrganizationProfile |
Example
Query
mutation createOrganizationProfile($input: CreateOrganizationProfileInput!) {
createOrganizationProfile(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
projectId
}
}
Variables
{"input": CreateOrganizationProfileInput}
Response
{
"data": {
"createOrganizationProfile": {
"clientMutationId": "xyz789",
"errors": [UserError],
"projectId": 4
}
}
}
createProject
Response
Returns a CreateProjectPayload
Arguments
| Name | Description |
|---|---|
input - CreateProjectInput!
|
Parameters for CreateProject |
Example
Query
mutation createProject($input: CreateProjectInput!) {
createProject(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"input": CreateProjectInput}
Response
{
"data": {
"createProject": {
"clientMutationId": "xyz789",
"errors": [UserError],
"project": Project
}
}
}
createProjectSubscription
Description
Create a new subscription. If a subscription already exists, we will return the matching subscription
Response
Returns a CreateProjectSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input - CreateProjectSubscriptionInput!
|
Parameters for CreateProjectSubscription |
Example
Query
mutation createProjectSubscription($input: CreateProjectSubscriptionInput!) {
createProjectSubscription(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
projectSubscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": CreateProjectSubscriptionInput}
Response
{
"data": {
"createProjectSubscription": {
"clientMutationId": "xyz789",
"errors": [UserError],
"projectSubscription": ProjectSubscription
}
}
}
createRoadmapUpdate
Response
Returns a CreateRoadmapUpdatePayload
Arguments
| Name | Description |
|---|---|
input - CreateRoadmapUpdateInput!
|
Parameters for CreateRoadmapUpdate |
Example
Query
mutation createRoadmapUpdate($input: CreateRoadmapUpdateInput!) {
createRoadmapUpdate(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
roadmapUpdate {
...RoadmapUpdateFragment
}
}
}
Variables
{"input": CreateRoadmapUpdateInput}
Response
{
"data": {
"createRoadmapUpdate": {
"clientMutationId": "xyz789",
"errors": [UserError],
"roadmapUpdate": RoadmapUpdate
}
}
}
createSecureConnection
Response
Returns a CreateSecureConnectionPayload
Arguments
| Name | Description |
|---|---|
input - CreateSecureConnectionInput!
|
Parameters for CreateSecureConnection |
Example
Query
mutation createSecureConnection($input: CreateSecureConnectionInput!) {
createSecureConnection(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": CreateSecureConnectionInput}
Response
{
"data": {
"createSecureConnection": {
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
createStage
Response
Returns a CreateStagePayload
Arguments
| Name | Description |
|---|---|
input - CreateStageInput!
|
Parameters for CreateStage |
Example
Query
mutation createStage($input: CreateStageInput!) {
createStage(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
stage {
...StageFragment
}
}
}
Variables
{"input": CreateStageInput}
Response
{
"data": {
"createStage": {
"clientMutationId": "xyz789",
"errors": [UserError],
"stage": Stage
}
}
}
createSubscription
Use createProjectSubscription intead
Description
Create a new subscription. If a subscription already exists, we will return the matching subscription
Response
Returns a CreateSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input - CreateSubscriptionInput!
|
Parameters for CreateSubscription |
Example
Query
mutation createSubscription($input: CreateSubscriptionInput!) {
createSubscription(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
subscription {
...SubscriptionFragment
}
}
}
Variables
{"input": CreateSubscriptionInput}
Response
{
"data": {
"createSubscription": {
"clientMutationId": "xyz789",
"errors": [UserError],
"subscription": Subscription
}
}
}
createTemplate
Response
Returns a CreateTemplatePayload
Arguments
| Name | Description |
|---|---|
input - CreateTemplateInput!
|
Parameters for CreateTemplate |
Example
Query
mutation createTemplate($input: CreateTemplateInput!) {
createTemplate(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
template {
...TemplateFragment
}
}
}
Variables
{"input": CreateTemplateInput}
Response
{
"data": {
"createTemplate": {
"clientMutationId": "abc123",
"errors": [UserError],
"template": Template
}
}
}
createWorkItem
Response
Returns a CreateWorkItemPayload
Arguments
| Name | Description |
|---|---|
input - CreateWorkItemInput!
|
Parameters for CreateWorkItem |
Example
Query
mutation createWorkItem($input: CreateWorkItemInput!) {
createWorkItem(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
workItem {
...WorkItemFragment
}
}
}
Variables
{"input": CreateWorkItemInput}
Response
{
"data": {
"createWorkItem": {
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
}
}
createWorkItemMovedUpdate
Response
Returns a CreateWorkItemMovedUpdatePayload
Arguments
| Name | Description |
|---|---|
input - CreateWorkItemMovedUpdateInput!
|
Parameters for CreateWorkItemMovedUpdate |
Example
Query
mutation createWorkItemMovedUpdate($input: CreateWorkItemMovedUpdateInput!) {
createWorkItemMovedUpdate(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
success
}
}
Variables
{"input": CreateWorkItemMovedUpdateInput}
Response
{
"data": {
"createWorkItemMovedUpdate": {
"clientMutationId": "xyz789",
"errors": [UserError],
"success": false
}
}
}
deleteAttributeDefinition
Response
Returns a DeleteAttributeDefinitionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAttributeDefinitionInput!
|
Parameters for DeleteAttributeDefinition |
Example
Query
mutation deleteAttributeDefinition($input: DeleteAttributeDefinitionInput!) {
deleteAttributeDefinition(input: $input) {
attributeDefinition {
...AttributeDefinitionFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": DeleteAttributeDefinitionInput}
Response
{
"data": {
"deleteAttributeDefinition": {
"attributeDefinition": AttributeDefinition,
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
deleteExternalContentLink
Response
Returns a DeleteExternalContentLinkPayload
Arguments
| Name | Description |
|---|---|
input - DeleteExternalContentLinkInput!
|
Parameters for DeleteExternalContentLink |
Example
Query
mutation deleteExternalContentLink($input: DeleteExternalContentLinkInput!) {
deleteExternalContentLink(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
stage {
...StageFragment
}
}
}
Variables
{"input": DeleteExternalContentLinkInput}
Response
{
"data": {
"deleteExternalContentLink": {
"clientMutationId": "abc123",
"errors": [UserError],
"stage": Stage
}
}
}
destroyUser
Response
Returns a DestroyUserAccountPayload
Arguments
| Name | Description |
|---|---|
input - DestroyUserAccountInput!
|
Parameters for DestroyUserAccount |
Example
Query
mutation destroyUser($input: DestroyUserAccountInput!) {
destroyUser(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
user {
...UserFragment
}
}
}
Variables
{"input": DestroyUserAccountInput}
Response
{
"data": {
"destroyUser": {
"clientMutationId": "abc123",
"errors": [UserError],
"user": User
}
}
}
duplicateAnnouncement
Response
Returns a DuplicateAnnouncementPayload
Arguments
| Name | Description |
|---|---|
input - DuplicateAnnouncementInput!
|
Parameters for DuplicateAnnouncement |
Example
Query
mutation duplicateAnnouncement($input: DuplicateAnnouncementInput!) {
duplicateAnnouncement(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": DuplicateAnnouncementInput}
Response
{
"data": {
"duplicateAnnouncement": {
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
importFeedback
Response
Returns an ImportFeedbackPayload
Arguments
| Name | Description |
|---|---|
input - ImportFeedbackInput!
|
Parameters for ImportFeedback |
Example
Query
mutation importFeedback($input: ImportFeedbackInput!) {
importFeedback(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
status
}
}
Variables
{"input": ImportFeedbackInput}
Response
{
"data": {
"importFeedback": {
"clientMutationId": "abc123",
"errors": [UserError],
"status": "abc123"
}
}
}
organizeFeedbacks
Response
Returns an OrganizeFeedbacksPayload
Arguments
| Name | Description |
|---|---|
input - OrganizeFeedbacksInput!
|
Parameters for OrganizeFeedbacks |
Example
Query
mutation organizeFeedbacks($input: OrganizeFeedbacksInput!) {
organizeFeedbacks(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
feedbacks {
...FeedbackFragment
}
}
}
Variables
{"input": OrganizeFeedbacksInput}
Response
{
"data": {
"organizeFeedbacks": {
"clientMutationId": "abc123",
"errors": [UserError],
"feedbacks": [Feedback]
}
}
}
previewAnnouncementSlack
Response
Returns a PreviewAnnouncementSlackPayload
Arguments
| Name | Description |
|---|---|
input - PreviewAnnouncementSlackInput!
|
Parameters for PreviewAnnouncementSlack |
Example
Query
mutation previewAnnouncementSlack($input: PreviewAnnouncementSlackInput!) {
previewAnnouncementSlack(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": PreviewAnnouncementSlackInput}
Response
{
"data": {
"previewAnnouncementSlack": {
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
promoteIdea
Description
Promote an Idea to a Roadmap item
Response
Returns a PromoteIdeaPayload
Arguments
| Name | Description |
|---|---|
input - PromoteIdeaInput!
|
Parameters for PromoteIdea |
Example
Query
mutation promoteIdea($input: PromoteIdeaInput!) {
promoteIdea(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
workItem {
...WorkItemFragment
}
}
}
Variables
{"input": PromoteIdeaInput}
Response
{
"data": {
"promoteIdea": {
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
}
}
publishAnnouncement
Response
Returns a PublishAnnouncementPayload
Arguments
| Name | Description |
|---|---|
input - PublishAnnouncementInput!
|
Parameters for PublishAnnouncement |
Example
Query
mutation publishAnnouncement($input: PublishAnnouncementInput!) {
publishAnnouncement(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": PublishAnnouncementInput}
Response
{
"data": {
"publishAnnouncement": {
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
publishWorkItem
Response
Returns a PublishWorkItemPayload
Arguments
| Name | Description |
|---|---|
input - PublishWorkItemInput!
|
Parameters for PublishWorkItem |
Example
Query
mutation publishWorkItem($input: PublishWorkItemInput!) {
publishWorkItem(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
workItem {
...WorkItemFragment
}
}
}
Variables
{"input": PublishWorkItemInput}
Response
{
"data": {
"publishWorkItem": {
"clientMutationId": "abc123",
"errors": [UserError],
"workItem": WorkItem
}
}
}
removeAllowedDomain
Response
Returns a RemoveAllowedDomainPayload
Arguments
| Name | Description |
|---|---|
input - RemoveAllowedDomainInput!
|
Parameters for RemoveAllowedDomain |
Example
Query
mutation removeAllowedDomain($input: RemoveAllowedDomainInput!) {
removeAllowedDomain(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
secureConnection {
...SecureConnectionSettingsFragment
}
}
}
Variables
{"input": RemoveAllowedDomainInput}
Response
{
"data": {
"removeAllowedDomain": {
"clientMutationId": "abc123",
"errors": [UserError],
"secureConnection": SecureConnectionSettings
}
}
}
removeAnnouncementAttachment
Response
Returns a RemoveAttachmentPayload
Arguments
| Name | Description |
|---|---|
input - RemoveAttachmentInput!
|
Parameters for RemoveAttachment |
Example
Query
mutation removeAnnouncementAttachment($input: RemoveAttachmentInput!) {
removeAnnouncementAttachment(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": RemoveAttachmentInput}
Response
{
"data": {
"removeAnnouncementAttachment": {
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
removeAnnouncementWorkItem
Response
Returns a RemoveAnnouncementWorkItemPayload
Arguments
| Name | Description |
|---|---|
input - RemoveAnnouncementWorkItemInput!
|
Parameters for RemoveAnnouncementWorkItem |
Example
Query
mutation removeAnnouncementWorkItem($input: RemoveAnnouncementWorkItemInput!) {
removeAnnouncementWorkItem(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": RemoveAnnouncementWorkItemInput}
Response
{
"data": {
"removeAnnouncementWorkItem": {
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
removeApiToken
Description
Remove an API Token
Response
Returns a RemoveApiTokenPayload
Arguments
| Name | Description |
|---|---|
input - RemoveApiTokenInput!
|
Parameters for RemoveApiToken |
Example
Query
mutation removeApiToken($input: RemoveApiTokenInput!) {
removeApiToken(input: $input) {
apiToken {
...ApiTokenFragment
}
clientMutationId
errors
}
}
Variables
{"input": RemoveApiTokenInput}
Response
{
"data": {
"removeApiToken": {
"apiToken": ApiToken,
"clientMutationId": "abc123",
"errors": ["abc123"]
}
}
}
removeCategory
Response
Returns a RemoveCategoryPayload
Arguments
| Name | Description |
|---|---|
input - RemoveCategoryInput!
|
Parameters for RemoveCategory |
Example
Query
mutation removeCategory($input: RemoveCategoryInput!) {
removeCategory(input: $input) {
category {
...CategoryFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": RemoveCategoryInput}
Response
{
"data": {
"removeCategory": {
"category": Category,
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
removeChangeType
Response
Returns a RemoveChangePayload
Arguments
| Name | Description |
|---|---|
input - RemoveChangeInput!
|
Parameters for RemoveChange |
Example
Query
mutation removeChangeType($input: RemoveChangeInput!) {
removeChangeType(input: $input) {
changeType {
...ChangeTypeFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": RemoveChangeInput}
Response
{
"data": {
"removeChangeType": {
"changeType": ChangeType,
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
removeConnectedSource
Response
Returns a RemoveSourcePayload
Arguments
| Name | Description |
|---|---|
input - RemoveSourceInput!
|
Parameters for RemoveSource |
Example
Query
mutation removeConnectedSource($input: RemoveSourceInput!) {
removeConnectedSource(input: $input) {
clientMutationId
deletedId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": RemoveSourceInput}
Response
{
"data": {
"removeConnectedSource": {
"clientMutationId": "xyz789",
"deletedId": 4,
"errors": [UserError]
}
}
}
removeEmailLogo
Response
Returns a RemoveEmailLogoPayload
Arguments
| Name | Description |
|---|---|
input - RemoveEmailLogoInput!
|
Parameters for RemoveEmailLogo |
Example
Query
mutation removeEmailLogo($input: RemoveEmailLogoInput!) {
removeEmailLogo(input: $input) {
clientMutationId
errors
mailAppSetting {
...MailAppSettingFragment
}
}
}
Variables
{"input": RemoveEmailLogoInput}
Response
{
"data": {
"removeEmailLogo": {
"clientMutationId": "abc123",
"errors": "xyz789",
"mailAppSetting": MailAppSetting
}
}
}
removeProjectEmptyFieldImage
Response
Returns a RemoveEmptyFieldImagePayload
Arguments
| Name | Description |
|---|---|
input - RemoveEmptyFieldImageInput!
|
Parameters for RemoveEmptyFieldImage |
Example
Query
mutation removeProjectEmptyFieldImage($input: RemoveEmptyFieldImageInput!) {
removeProjectEmptyFieldImage(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"input": RemoveEmptyFieldImageInput}
Response
{
"data": {
"removeProjectEmptyFieldImage": {
"clientMutationId": "abc123",
"errors": [UserError],
"project": Project
}
}
}
removeProjectFavicon
Response
Returns a RemoveFaviconPayload
Arguments
| Name | Description |
|---|---|
input - RemoveFaviconInput!
|
Parameters for RemoveFavicon |
Example
Query
mutation removeProjectFavicon($input: RemoveFaviconInput!) {
removeProjectFavicon(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"input": RemoveFaviconInput}
Response
{
"data": {
"removeProjectFavicon": {
"clientMutationId": "xyz789",
"errors": [UserError],
"project": Project
}
}
}
removeProjectLogo
Response
Returns a RemoveLogoPayload
Arguments
| Name | Description |
|---|---|
input - RemoveLogoInput!
|
Parameters for RemoveLogo |
Example
Query
mutation removeProjectLogo($input: RemoveLogoInput!) {
removeProjectLogo(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"input": RemoveLogoInput}
Response
{
"data": {
"removeProjectLogo": {
"clientMutationId": "abc123",
"errors": [UserError],
"project": Project
}
}
}
removeProjectSubscribers
Use unsubscribeProjectSubscription instead
Response
Returns a RemoveFromProjectPayload
Arguments
| Name | Description |
|---|---|
input - RemoveFromProjectInput!
|
Parameters for RemoveFromProject |
Example
Query
mutation removeProjectSubscribers($input: RemoveFromProjectInput!) {
removeProjectSubscribers(input: $input) {
clientMutationId
subscriberIds
}
}
Variables
{"input": RemoveFromProjectInput}
Response
{
"data": {
"removeProjectSubscribers": {
"clientMutationId": "xyz789",
"subscriberIds": ["4"]
}
}
}
removeProjectSubscription
Description
Removes a project subscription
Response
Returns a RemoveProjectSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input - RemoveProjectSubscriptionInput!
|
Parameters for RemoveProjectSubscription |
Example
Query
mutation removeProjectSubscription($input: RemoveProjectSubscriptionInput!) {
removeProjectSubscription(input: $input) {
clientMutationId
projectSubscriptionId
}
}
Variables
{"input": RemoveProjectSubscriptionInput}
Response
{
"data": {
"removeProjectSubscription": {
"clientMutationId": "xyz789",
"projectSubscriptionId": "4"
}
}
}
removeProjectUser
Response
Returns a RemoveProjectUserPayload
Arguments
| Name | Description |
|---|---|
input - RemoveProjectUserInput!
|
Parameters for RemoveProjectUser |
Example
Query
mutation removeProjectUser($input: RemoveProjectUserInput!) {
removeProjectUser(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"input": RemoveProjectUserInput}
Response
{
"data": {
"removeProjectUser": {
"clientMutationId": "abc123",
"errors": [UserError],
"project": Project
}
}
}
removeSecureConnection
Response
Returns a RemoveSecureConnectionPayload
Arguments
| Name | Description |
|---|---|
input - RemoveSecureConnectionInput!
|
Parameters for RemoveSecureConnection |
Example
Query
mutation removeSecureConnection($input: RemoveSecureConnectionInput!) {
removeSecureConnection(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": RemoveSecureConnectionInput}
Response
{
"data": {
"removeSecureConnection": {
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
removeSubscription
Use unsubscribeProjectSubscription intead
Response
Returns a RemoveSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input - RemoveSubscriptionInput!
|
Parameters for RemoveSubscription |
Example
Query
mutation removeSubscription($input: RemoveSubscriptionInput!) {
removeSubscription(input: $input) {
clientMutationId
errors
subscription {
...SubscriptionFragment
}
}
}
Variables
{"input": RemoveSubscriptionInput}
Response
{
"data": {
"removeSubscription": {
"clientMutationId": "xyz789",
"errors": ["xyz789"],
"subscription": Subscription
}
}
}
removeSubscriptionByEmail
Use unsubscribeProjectSubscription intead
Response
Returns a RemoveSubscriptionByEmailPayload
Arguments
| Name | Description |
|---|---|
input - RemoveSubscriptionByEmailInput!
|
Parameters for RemoveSubscriptionByEmail |
Example
Query
mutation removeSubscriptionByEmail($input: RemoveSubscriptionByEmailInput!) {
removeSubscriptionByEmail(input: $input) {
clientMutationId
errors
subscription {
...SubscriptionFragment
}
}
}
Variables
{"input": RemoveSubscriptionByEmailInput}
Response
{
"data": {
"removeSubscriptionByEmail": {
"clientMutationId": "xyz789",
"errors": ["xyz789"],
"subscription": Subscription
}
}
}
removeTemplateAttachment
Response
Returns a RemoveTemplateAttachmentPayload
Arguments
| Name | Description |
|---|---|
input - RemoveTemplateAttachmentInput!
|
Parameters for RemoveTemplateAttachment |
Example
Query
mutation removeTemplateAttachment($input: RemoveTemplateAttachmentInput!) {
removeTemplateAttachment(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
template {
...TemplateFragment
}
}
}
Variables
{"input": RemoveTemplateAttachmentInput}
Response
{
"data": {
"removeTemplateAttachment": {
"clientMutationId": "xyz789",
"errors": [UserError],
"template": Template
}
}
}
removeUserAvatarImage
Response
Returns a RemoveAvatarImagePayload
Arguments
| Name | Description |
|---|---|
input - RemoveAvatarImageInput!
|
Parameters for RemoveAvatarImage |
Example
Query
mutation removeUserAvatarImage($input: RemoveAvatarImageInput!) {
removeUserAvatarImage(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
user {
...UserFragment
}
}
}
Variables
{"input": RemoveAvatarImageInput}
Response
{
"data": {
"removeUserAvatarImage": {
"clientMutationId": "xyz789",
"errors": [UserError],
"user": User
}
}
}
removeWorkItemHeroImage
Response
Returns a RemoveHeroImagePayload
Arguments
| Name | Description |
|---|---|
input - RemoveHeroImageInput!
|
Parameters for RemoveHeroImage |
Example
Query
mutation removeWorkItemHeroImage($input: RemoveHeroImageInput!) {
removeWorkItemHeroImage(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
workItem {
...WorkItemFragment
}
}
}
Variables
{"input": RemoveHeroImageInput}
Response
{
"data": {
"removeWorkItemHeroImage": {
"clientMutationId": "abc123",
"errors": [UserError],
"workItem": WorkItem
}
}
}
removeWorkItemOwner
Response
Returns a RemoveOwnerPayload
Arguments
| Name | Description |
|---|---|
input - RemoveOwnerInput!
|
Parameters for RemoveOwner |
Example
Query
mutation removeWorkItemOwner($input: RemoveOwnerInput!) {
removeWorkItemOwner(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
workItem {
...WorkItemFragment
}
}
}
Variables
{"input": RemoveOwnerInput}
Response
{
"data": {
"removeWorkItemOwner": {
"clientMutationId": "abc123",
"errors": [UserError],
"workItem": WorkItem
}
}
}
reorderCategory
Response
Returns a ReorderCategoryPayload
Arguments
| Name | Description |
|---|---|
input - ReorderCategoryInput!
|
Parameters for ReorderCategory |
Example
Query
mutation reorderCategory($input: ReorderCategoryInput!) {
reorderCategory(input: $input) {
categories {
...CategoryFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": ReorderCategoryInput}
Response
{
"data": {
"reorderCategory": {
"categories": [Category],
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
reorderStage
Response
Returns a ReorderStagePayload
Arguments
| Name | Description |
|---|---|
input - ReorderStageInput!
|
Parameters for ReorderStage |
Example
Query
mutation reorderStage($input: ReorderStageInput!) {
reorderStage(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
stages {
...StageFragment
}
}
}
Variables
{"input": ReorderStageInput}
Response
{
"data": {
"reorderStage": {
"clientMutationId": "xyz789",
"errors": [UserError],
"stages": [Stage]
}
}
}
repositionWorkItem
Response
Returns a RepositionWorkItemPayload
Arguments
| Name | Description |
|---|---|
input - RepositionWorkItemInput!
|
Parameters for RepositionWorkItem |
Example
Query
mutation repositionWorkItem($input: RepositionWorkItemInput!) {
repositionWorkItem(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
sourceStage {
...StageFragment
}
targetStage {
...StageFragment
}
workItem {
...WorkItemFragment
}
}
}
Variables
{"input": RepositionWorkItemInput}
Response
{
"data": {
"repositionWorkItem": {
"clientMutationId": "xyz789",
"errors": [UserError],
"sourceStage": Stage,
"targetStage": Stage,
"workItem": WorkItem
}
}
}
resubscribeProjectSubscription
Description
Resubscribes a project subscription
Response
Returns a ResubscribeProjectSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input - ResubscribeProjectSubscriptionInput!
|
Parameters for ResubscribeProjectSubscription |
Example
Query
mutation resubscribeProjectSubscription($input: ResubscribeProjectSubscriptionInput!) {
resubscribeProjectSubscription(input: $input) {
clientMutationId
projectSubscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": ResubscribeProjectSubscriptionInput}
Response
{
"data": {
"resubscribeProjectSubscription": {
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscription
}
}
}
resubscribeToProject
Use resubscribeProjectSubscription instead
Response
Returns a ResubscribeToProjectPayload
Arguments
| Name | Description |
|---|---|
input - ResubscribeToProjectInput!
|
Parameters for ResubscribeToProject |
Example
Query
mutation resubscribeToProject($input: ResubscribeToProjectInput!) {
resubscribeToProject(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
subscriberIds
}
}
Variables
{"input": ResubscribeToProjectInput}
Response
{
"data": {
"resubscribeToProject": {
"clientMutationId": "abc123",
"errors": [UserError],
"subscriberIds": [4]
}
}
}
scheduleAnnouncement
Response
Returns a ScheduleAnnouncementPayload
Arguments
| Name | Description |
|---|---|
input - ScheduleAnnouncementInput!
|
Parameters for ScheduleAnnouncement |
Example
Query
mutation scheduleAnnouncement($input: ScheduleAnnouncementInput!) {
scheduleAnnouncement(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": ScheduleAnnouncementInput}
Response
{
"data": {
"scheduleAnnouncement": {
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
sendPromoteTest
Description
Send a test promotion email to the current user
Response
Returns a SendPromoteTestPayload
Arguments
| Name | Description |
|---|---|
input - SendPromoteTestInput!
|
Parameters for SendPromoteTest |
Example
Query
mutation sendPromoteTest($input: SendPromoteTestInput!) {
sendPromoteTest(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
success
}
}
Variables
{"input": SendPromoteTestInput}
Response
{
"data": {
"sendPromoteTest": {
"clientMutationId": "xyz789",
"errors": [UserError],
"success": true
}
}
}
sendRoadmapUpdateTestEmail
Response
Returns a SendRoadmapUpdateTestEmailPayload
Arguments
| Name | Description |
|---|---|
input - SendRoadmapUpdateTestEmailInput!
|
Parameters for SendRoadmapUpdateTestEmail |
Example
Query
mutation sendRoadmapUpdateTestEmail($input: SendRoadmapUpdateTestEmailInput!) {
sendRoadmapUpdateTestEmail(input: $input) {
clientMutationId
success
}
}
Variables
{"input": SendRoadmapUpdateTestEmailInput}
Response
{
"data": {
"sendRoadmapUpdateTestEmail": {
"clientMutationId": "abc123",
"success": true
}
}
}
subscribeProjectSubscriptionCategory
Description
Subscribes a project subscription to a category
Response
Arguments
| Name | Description |
|---|---|
input - SubscribeProjectSubscriptionCategoryInput!
|
Parameters for SubscribeProjectSubscriptionCategory |
Example
Query
mutation subscribeProjectSubscriptionCategory($input: SubscribeProjectSubscriptionCategoryInput!) {
subscribeProjectSubscriptionCategory(input: $input) {
clientMutationId
projectSubscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": SubscribeProjectSubscriptionCategoryInput}
Response
{
"data": {
"subscribeProjectSubscriptionCategory": {
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscription
}
}
}
subscribeProjectSubscriptionWorkItem
Description
Subscribes a project subscription to a work item
Response
Arguments
| Name | Description |
|---|---|
input - SubscribeProjectSubscriptionWorkItemInput!
|
Parameters for SubscribeProjectSubscriptionWorkItem |
Example
Query
mutation subscribeProjectSubscriptionWorkItem($input: SubscribeProjectSubscriptionWorkItemInput!) {
subscribeProjectSubscriptionWorkItem(input: $input) {
clientMutationId
projectSubscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": SubscribeProjectSubscriptionWorkItemInput}
Response
{
"data": {
"subscribeProjectSubscriptionWorkItem": {
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscription
}
}
}
toggleEventType
Response
Returns a ToggleEventPayload
Arguments
| Name | Description |
|---|---|
input - ToggleEventInput!
|
Parameters for ToggleEvent |
Example
Query
mutation toggleEventType($input: ToggleEventInput!) {
toggleEventType(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
subscription {
...SubscriptionFragment
}
}
}
Variables
{"input": ToggleEventInput}
Response
{
"data": {
"toggleEventType": {
"clientMutationId": "abc123",
"errors": [UserError],
"subscription": Subscription
}
}
}
togglePublicStageDescriptions
Response
Returns a TogglePublicStageDescriptionsPayload
Arguments
| Name | Description |
|---|---|
input - TogglePublicStageDescriptionsInput!
|
Parameters for TogglePublicStageDescriptions |
Example
Query
mutation togglePublicStageDescriptions($input: TogglePublicStageDescriptionsInput!) {
togglePublicStageDescriptions(input: $input) {
clientMutationId
success
}
}
Variables
{"input": TogglePublicStageDescriptionsInput}
Response
{
"data": {
"togglePublicStageDescriptions": {
"clientMutationId": "abc123",
"success": false
}
}
}
togglePublishedIdea
Description
Attributes for updating an idea
Response
Returns a TogglePublishedIdeaPayload
Arguments
| Name | Description |
|---|---|
input - TogglePublishedIdeaInput!
|
Parameters for TogglePublishedIdea |
Example
Query
mutation togglePublishedIdea($input: TogglePublishedIdeaInput!) {
togglePublishedIdea(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
idea {
...IdeaFragment
}
}
}
Variables
{"input": TogglePublishedIdeaInput}
Response
{
"data": {
"togglePublishedIdea": {
"clientMutationId": "xyz789",
"errors": [UserError],
"idea": Idea
}
}
}
toggleSubscriberReport
Response
Returns a ToggleSubscriberReportPayload
Arguments
| Name | Description |
|---|---|
input - ToggleSubscriberReportInput!
|
Parameters for ToggleSubscriberReport |
Example
Query
mutation toggleSubscriberReport($input: ToggleSubscriberReportInput!) {
toggleSubscriberReport(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": ToggleSubscriberReportInput}
Response
{
"data": {
"toggleSubscriberReport": {
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
trackViewedAnnouncements
Response
Returns a TrackViewedAnnouncementsPayload
Arguments
| Name | Description |
|---|---|
input - TrackViewedAnnouncementsInput!
|
Parameters for TrackViewedAnnouncements |
Example
Query
mutation trackViewedAnnouncements($input: TrackViewedAnnouncementsInput!) {
trackViewedAnnouncements(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
ok
}
}
Variables
{"input": TrackViewedAnnouncementsInput}
Response
{
"data": {
"trackViewedAnnouncements": {
"clientMutationId": "xyz789",
"errors": [UserError],
"ok": false
}
}
}
triggerTestEmail
Response
Returns a TriggerTestEmailPayload
Arguments
| Name | Description |
|---|---|
input - TriggerTestEmailInput!
|
Parameters for TriggerTestEmail |
Example
Query
mutation triggerTestEmail($input: TriggerTestEmailInput!) {
triggerTestEmail(input: $input) {
clientMutationId
errors
}
}
Variables
{"input": TriggerTestEmailInput}
Response
{
"data": {
"triggerTestEmail": {
"clientMutationId": "abc123",
"errors": "abc123"
}
}
}
unarchiveAnnouncement
Response
Returns an UnarchiveAnnouncementPayload
Arguments
| Name | Description |
|---|---|
input - UnarchiveAnnouncementInput!
|
Parameters for UnarchiveAnnouncement |
Example
Query
mutation unarchiveAnnouncement($input: UnarchiveAnnouncementInput!) {
unarchiveAnnouncement(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": UnarchiveAnnouncementInput}
Response
{
"data": {
"unarchiveAnnouncement": {
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
unarchiveFeedback
Response
Returns an UnarchiveFeedbackPayload
Arguments
| Name | Description |
|---|---|
input - UnarchiveFeedbackInput!
|
Parameters for UnarchiveFeedback |
Example
Query
mutation unarchiveFeedback($input: UnarchiveFeedbackInput!) {
unarchiveFeedback(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
feedback {
...FeedbackFragment
}
}
}
Variables
{"input": UnarchiveFeedbackInput}
Response
{
"data": {
"unarchiveFeedback": {
"clientMutationId": "abc123",
"errors": [UserError],
"feedback": Feedback
}
}
}
unarchiveFeedbacks
Response
Returns an UnarchiveFeedbacksPayload
Arguments
| Name | Description |
|---|---|
input - UnarchiveFeedbacksInput!
|
Parameters for UnarchiveFeedbacks |
Example
Query
mutation unarchiveFeedbacks($input: UnarchiveFeedbacksInput!) {
unarchiveFeedbacks(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
feedbacks {
...FeedbackFragment
}
}
}
Variables
{"input": UnarchiveFeedbacksInput}
Response
{
"data": {
"unarchiveFeedbacks": {
"clientMutationId": "xyz789",
"errors": [UserError],
"feedbacks": [Feedback]
}
}
}
unarchiveIdeas
Response
Returns an UnarchiveIdeasPayload
Arguments
| Name | Description |
|---|---|
input - UnarchiveIdeasInput!
|
Parameters for UnarchiveIdeas |
Example
Query
mutation unarchiveIdeas($input: UnarchiveIdeasInput!) {
unarchiveIdeas(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
ideas {
...IdeaFragment
}
}
}
Variables
{"input": UnarchiveIdeasInput}
Response
{
"data": {
"unarchiveIdeas": {
"clientMutationId": "abc123",
"errors": [UserError],
"ideas": [Idea]
}
}
}
unarchiveWorkItem
Response
Returns an UnarchiveWorkItemPayload
Arguments
| Name | Description |
|---|---|
input - UnarchiveWorkItemInput!
|
Parameters for UnarchiveWorkItem |
Example
Query
mutation unarchiveWorkItem($input: UnarchiveWorkItemInput!) {
unarchiveWorkItem(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
workItem {
...WorkItemFragment
}
}
}
Variables
{"input": UnarchiveWorkItemInput}
Response
{
"data": {
"unarchiveWorkItem": {
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
}
}
unpublishAnnouncement
Response
Returns an UnpublishAnnouncementPayload
Arguments
| Name | Description |
|---|---|
input - UnpublishAnnouncementInput!
|
Parameters for UnpublishAnnouncement |
Example
Query
mutation unpublishAnnouncement($input: UnpublishAnnouncementInput!) {
unpublishAnnouncement(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": UnpublishAnnouncementInput}
Response
{
"data": {
"unpublishAnnouncement": {
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
unpublishWorkItem
Response
Returns an UnpublishWorkItemPayload
Arguments
| Name | Description |
|---|---|
input - UnpublishWorkItemInput!
|
Parameters for UnpublishWorkItem |
Example
Query
mutation unpublishWorkItem($input: UnpublishWorkItemInput!) {
unpublishWorkItem(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
workItem {
...WorkItemFragment
}
}
}
Variables
{"input": UnpublishWorkItemInput}
Response
{
"data": {
"unpublishWorkItem": {
"clientMutationId": "abc123",
"errors": [UserError],
"workItem": WorkItem
}
}
}
unscheduleAnnouncement
Response
Returns an UnscheduleAnnouncementPayload
Arguments
| Name | Description |
|---|---|
input - UnscheduleAnnouncementInput!
|
Parameters for UnscheduleAnnouncement |
Example
Query
mutation unscheduleAnnouncement($input: UnscheduleAnnouncementInput!) {
unscheduleAnnouncement(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": UnscheduleAnnouncementInput}
Response
{
"data": {
"unscheduleAnnouncement": {
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
unsubscribeAll
Use unsubscribeProjectSubscription intead
Response
Returns an UnsubscribeAllPayload
Arguments
| Name | Description |
|---|---|
input - UnsubscribeAllInput!
|
Parameters for UnsubscribeAll |
Example
Query
mutation unsubscribeAll($input: UnsubscribeAllInput!) {
unsubscribeAll(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
projectId
}
}
Variables
{"input": UnsubscribeAllInput}
Response
{
"data": {
"unsubscribeAll": {
"clientMutationId": "abc123",
"errors": [UserError],
"projectId": "4"
}
}
}
unsubscribeFromProject
Use unsubscribeProjectSubscription instead
Response
Returns an UnsubscribeFromProjectPayload
Arguments
| Name | Description |
|---|---|
input - UnsubscribeFromProjectInput!
|
Parameters for UnsubscribeFromProject |
Example
Query
mutation unsubscribeFromProject($input: UnsubscribeFromProjectInput!) {
unsubscribeFromProject(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
subscriberIds
}
}
Variables
{"input": UnsubscribeFromProjectInput}
Response
{
"data": {
"unsubscribeFromProject": {
"clientMutationId": "abc123",
"errors": [UserError],
"subscriberIds": ["4"]
}
}
}
unsubscribeProjectSubscription
Description
Unsubscribes a project subscription
Response
Returns an UnsubscribeProjectSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input - UnsubscribeProjectSubscriptionInput!
|
Parameters for UnsubscribeProjectSubscription |
Example
Query
mutation unsubscribeProjectSubscription($input: UnsubscribeProjectSubscriptionInput!) {
unsubscribeProjectSubscription(input: $input) {
clientMutationId
projectSubscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": UnsubscribeProjectSubscriptionInput}
Response
{
"data": {
"unsubscribeProjectSubscription": {
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscription
}
}
}
unsubscribeProjectSubscriptionAll
Description
Unsubscribes a project subscription from everything
Response
Returns an UnsubscribeProjectSubscriptionAllPayload
Arguments
| Name | Description |
|---|---|
input - UnsubscribeProjectSubscriptionAllInput!
|
Parameters for UnsubscribeProjectSubscriptionAll |
Example
Query
mutation unsubscribeProjectSubscriptionAll($input: UnsubscribeProjectSubscriptionAllInput!) {
unsubscribeProjectSubscriptionAll(input: $input) {
clientMutationId
projectSubscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": UnsubscribeProjectSubscriptionAllInput}
Response
{
"data": {
"unsubscribeProjectSubscriptionAll": {
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscription
}
}
}
unsubscribeProjectSubscriptionCategory
Description
Unsubscribes a project subscription from a category
Response
Arguments
| Name | Description |
|---|---|
input - UnsubscribeProjectSubscriptionCategoryInput!
|
Parameters for UnsubscribeProjectSubscriptionCategory |
Example
Query
mutation unsubscribeProjectSubscriptionCategory($input: UnsubscribeProjectSubscriptionCategoryInput!) {
unsubscribeProjectSubscriptionCategory(input: $input) {
clientMutationId
projectSubscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": UnsubscribeProjectSubscriptionCategoryInput}
Response
{
"data": {
"unsubscribeProjectSubscriptionCategory": {
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscription
}
}
}
unsubscribeProjectSubscriptionWorkItem
Description
Unsubscribes a project subscription to a work item
Response
Arguments
| Name | Description |
|---|---|
input - UnsubscribeProjectSubscriptionWorkItemInput!
|
Parameters for UnsubscribeProjectSubscriptionWorkItem |
Example
Query
mutation unsubscribeProjectSubscriptionWorkItem($input: UnsubscribeProjectSubscriptionWorkItemInput!) {
unsubscribeProjectSubscriptionWorkItem(input: $input) {
clientMutationId
projectSubscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": UnsubscribeProjectSubscriptionWorkItemInput}
Response
{
"data": {
"unsubscribeProjectSubscriptionWorkItem": {
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscription
}
}
}
updateAnnouncement
Response
Returns an UpdateAnnouncementPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAnnouncementInput!
|
Parameters for UpdateAnnouncement |
Example
Query
mutation updateAnnouncement($input: UpdateAnnouncementInput!) {
updateAnnouncement(input: $input) {
announcement {
...AnnouncementFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": UpdateAnnouncementInput}
Response
{
"data": {
"updateAnnouncement": {
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
updateAttribute
Response
Returns an UpdateAttributePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAttributeInput!
|
Parameters for UpdateAttribute |
Example
Query
mutation updateAttribute($input: UpdateAttributeInput!) {
updateAttribute(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
node {
...HasAttributesFragment
}
}
}
Variables
{"input": UpdateAttributeInput}
Response
{
"data": {
"updateAttribute": {
"clientMutationId": "abc123",
"errors": [UserError],
"node": HasAttributes
}
}
}
updateCategory
Response
Returns an UpdateCategoryPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCategoryInput!
|
Parameters for UpdateCategory |
Example
Query
mutation updateCategory($input: UpdateCategoryInput!) {
updateCategory(input: $input) {
category {
...CategoryFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": UpdateCategoryInput}
Response
{
"data": {
"updateCategory": {
"category": Category,
"clientMutationId": "xyz789",
"errors": [UserError]
}
}
}
updateChangeType
Response
Returns an UpdateChangePayload
Arguments
| Name | Description |
|---|---|
input - UpdateChangeInput!
|
Parameters for UpdateChange |
Example
Query
mutation updateChangeType($input: UpdateChangeInput!) {
updateChangeType(input: $input) {
changeType {
...ChangeTypeFragment
}
clientMutationId
errors {
...UserErrorFragment
}
}
}
Variables
{"input": UpdateChangeInput}
Response
{
"data": {
"updateChangeType": {
"changeType": ChangeType,
"clientMutationId": "abc123",
"errors": [UserError]
}
}
}
updateExternalContentLink
Response
Returns an UpdateExternalContentLinkPayload
Arguments
| Name | Description |
|---|---|
input - UpdateExternalContentLinkInput!
|
Parameters for UpdateExternalContentLink |
Example
Query
mutation updateExternalContentLink($input: UpdateExternalContentLinkInput!) {
updateExternalContentLink(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
stage {
...StageFragment
}
}
}
Variables
{"input": UpdateExternalContentLinkInput}
Response
{
"data": {
"updateExternalContentLink": {
"clientMutationId": "abc123",
"errors": [UserError],
"stage": Stage
}
}
}
updateFeedback
Response
Returns an UpdateFeedbackPayload
Arguments
| Name | Description |
|---|---|
input - UpdateFeedbackInput!
|
Parameters for UpdateFeedback |
Example
Query
mutation updateFeedback($input: UpdateFeedbackInput!) {
updateFeedback(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
feedback {
...FeedbackFragment
}
}
}
Variables
{"input": UpdateFeedbackInput}
Response
{
"data": {
"updateFeedback": {
"clientMutationId": "xyz789",
"errors": [UserError],
"feedback": Feedback
}
}
}
updateIdea
Description
Attributes for updating an idea
Response
Returns an UpdateIdeaPayload
Arguments
| Name | Description |
|---|---|
input - UpdateIdeaInput!
|
Parameters for UpdateIdea |
Example
Query
mutation updateIdea($input: UpdateIdeaInput!) {
updateIdea(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
idea {
...IdeaFragment
}
}
}
Variables
{"input": UpdateIdeaInput}
Response
{
"data": {
"updateIdea": {
"clientMutationId": "xyz789",
"errors": [UserError],
"idea": Idea
}
}
}
updateMailAppSettings
Response
Returns an UpdateMailAppSettingsPayload
Arguments
| Name | Description |
|---|---|
input - UpdateMailAppSettingsInput!
|
Parameters for UpdateMailAppSettings |
Example
Query
mutation updateMailAppSettings($input: UpdateMailAppSettingsInput!) {
updateMailAppSettings(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
mailAppSetting {
...MailAppSettingFragment
}
}
}
Variables
{"input": UpdateMailAppSettingsInput}
Response
{
"data": {
"updateMailAppSettings": {
"clientMutationId": "abc123",
"errors": [UserError],
"mailAppSetting": MailAppSetting
}
}
}
updateOnboardingTasks
Response
Returns an UpdateOnboardingTasksPayload
Arguments
| Name | Description |
|---|---|
input - UpdateOnboardingTasksInput!
|
Parameters for UpdateOnboardingTasks |
Example
Query
mutation updateOnboardingTasks($input: UpdateOnboardingTasksInput!) {
updateOnboardingTasks(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
onboardingTasks {
...OnboardingTasksFragment
}
}
}
Variables
{"input": UpdateOnboardingTasksInput}
Response
{
"data": {
"updateOnboardingTasks": {
"clientMutationId": "xyz789",
"errors": [UserError],
"onboardingTasks": OnboardingTasks
}
}
}
updateProject
Response
Returns an UpdateProjectPayload
Arguments
| Name | Description |
|---|---|
input - UpdateProjectInput!
|
Parameters for UpdateProject |
Example
Query
mutation updateProject($input: UpdateProjectInput!) {
updateProject(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"input": UpdateProjectInput}
Response
{
"data": {
"updateProject": {
"clientMutationId": "abc123",
"errors": [UserError],
"project": Project
}
}
}
updateProjectSubscription
Description
Updates a project subscription's categories or work items
Response
Returns an updateProjectSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input - updateProjectSubscriptionInput!
|
Parameters for updateProjectSubscription |
Example
Query
mutation updateProjectSubscription($input: updateProjectSubscriptionInput!) {
updateProjectSubscription(input: $input) {
clientMutationId
projectSubscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": updateProjectSubscriptionInput}
Response
{
"data": {
"updateProjectSubscription": {
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscription
}
}
}
updateProjectUserRole
Description
Update the user's role for the given project
Response
Returns an UpdateProjectUserRolePayload
Arguments
| Name | Description |
|---|---|
input - UpdateProjectUserRoleInput!
|
Parameters for UpdateProjectUserRole |
Example
Query
mutation updateProjectUserRole($input: UpdateProjectUserRoleInput!) {
updateProjectUserRole(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
projectUser {
...UserFragment
}
}
}
Variables
{"input": UpdateProjectUserRoleInput}
Response
{
"data": {
"updateProjectUserRole": {
"clientMutationId": "xyz789",
"errors": [UserError],
"projectUser": User
}
}
}
updateSecureConnection
Response
Returns an UpdateSecureConnectionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSecureConnectionInput!
|
Parameters for UpdateSecureConnection |
Example
Query
mutation updateSecureConnection($input: UpdateSecureConnectionInput!) {
updateSecureConnection(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
secureConnection {
...SecureConnectionSettingsFragment
}
}
}
Variables
{"input": UpdateSecureConnectionInput}
Response
{
"data": {
"updateSecureConnection": {
"clientMutationId": "xyz789",
"errors": [UserError],
"secureConnection": SecureConnectionSettings
}
}
}
updateStage
Response
Returns an UpdateStagePayload
Arguments
| Name | Description |
|---|---|
input - UpdateStageInput!
|
Parameters for UpdateStage |
Example
Query
mutation updateStage($input: UpdateStageInput!) {
updateStage(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
stage {
...StageFragment
}
}
}
Variables
{"input": UpdateStageInput}
Response
{
"data": {
"updateStage": {
"clientMutationId": "abc123",
"errors": [UserError],
"stage": Stage
}
}
}
updateSubscription
Use updateProjectSubscription intead
Response
Returns an UpdateSubscriptionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSubscriptionInput!
|
Parameters for UpdateSubscription |
Example
Query
mutation updateSubscription($input: UpdateSubscriptionInput!) {
updateSubscription(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
subscription {
...SubscriptionFragment
}
}
}
Variables
{"input": UpdateSubscriptionInput}
Response
{
"data": {
"updateSubscription": {
"clientMutationId": "abc123",
"errors": [UserError],
"subscription": Subscription
}
}
}
updateSubscriptionByEmail
Use updateProjectSubscription intead
Response
Returns an UpdateSubscriptionByEmailPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSubscriptionByEmailInput!
|
Parameters for UpdateSubscriptionByEmail |
Example
Query
mutation updateSubscriptionByEmail($input: UpdateSubscriptionByEmailInput!) {
updateSubscriptionByEmail(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
subscription {
...ProjectSubscriptionFragment
}
}
}
Variables
{"input": UpdateSubscriptionByEmailInput}
Response
{
"data": {
"updateSubscriptionByEmail": {
"clientMutationId": "abc123",
"errors": [UserError],
"subscription": ProjectSubscription
}
}
}
updateTemplate
Response
Returns an UpdateTemplatePayload
Arguments
| Name | Description |
|---|---|
input - UpdateTemplateInput!
|
Parameters for UpdateTemplate |
Example
Query
mutation updateTemplate($input: UpdateTemplateInput!) {
updateTemplate(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
template {
...TemplateFragment
}
}
}
Variables
{"input": UpdateTemplateInput}
Response
{
"data": {
"updateTemplate": {
"clientMutationId": "xyz789",
"errors": [UserError],
"template": Template
}
}
}
updateUser
Response
Returns an UpdateUserPayload
Arguments
| Name | Description |
|---|---|
input - UpdateUserInput!
|
Parameters for UpdateUser |
Example
Query
mutation updateUser($input: UpdateUserInput!) {
updateUser(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
user {
...UserFragment
}
}
}
Variables
{"input": UpdateUserInput}
Response
{
"data": {
"updateUser": {
"clientMutationId": "abc123",
"errors": [UserError],
"user": User
}
}
}
updateWorkItem
Response
Returns an UpdateWorkItemPayload
Arguments
| Name | Description |
|---|---|
input - UpdateWorkItemInput!
|
Parameters for UpdateWorkItem |
Example
Query
mutation updateWorkItem($input: UpdateWorkItemInput!) {
updateWorkItem(input: $input) {
clientMutationId
errors {
...UserErrorFragment
}
workItem {
...WorkItemFragment
}
}
}
Variables
{"input": UpdateWorkItemInput}
Response
{
"data": {
"updateWorkItem": {
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
}
}
Types
Announcement
Fields
| Field Name | Description |
|---|---|
archived - Boolean!
|
|
author - String
|
The name of the author of the announcement |
authorWithFallback - String
|
|
categories - [Category!]!
|
The categories that are associated with this announcement |
changeTypes - ChangeTypeConnection!
|
The types of changes associated with an announcement |
Arguments
|
|
connectedSources - ConnectedSourceConnection
|
Connected external data sources. Internal use only |
Arguments
|
|
content - String
|
|
contentGenerators - ContentGeneratorConnection
|
|
Arguments
|
|
contentHtml - String
|
The HTML representation of the content |
contentPlainText - String
|
The plain text representation of the content |
contentType - String!
|
Defines the type of schema the content follows, draftjs to be deprecated. |
createdAt - ISO8601DateTime!
|
|
deactivatedAt - ISO8601DateTime
|
|
description - String
|
The description of the announcement |
descriptionWithFallback - String
|
|
doNotIndex - Boolean
|
Whether the announcement should be indexed by search engines |
emailAnalytics - EmailAnalyticsObject
|
|
Arguments
|
|
excerpt - String
|
A short summary of the announcement, can be either auto-generated from content, or overridden by the author |
excerptWithFallback - String
|
|
exportFeedbacks - [Feedback!]
|
|
externalContentLinks - [ExternalContentLink!]
|
The external content links that are associated with this announcement |
feedbackHappyCount - Int!
|
|
feedbackMehCount - Int!
|
|
feedbackSadCount - Int!
|
|
feedbacks - FeedbackConnection
|
|
Arguments
|
|
hasPendingContentGenerators - Boolean
|
If there are any content generators in a pending or generating state |
headline - String
|
The headline of the announcement, displayed |
heroImage - Image
|
The hero image of the announcement |
id - ID!
|
|
inPublishedDigest - Boolean!
|
|
name - String!
|
The name of the announcement |
notificationsExcerptOnly - Boolean
|
If notifications are sent for this announcement, only show the excerpt (instead of the full content) when true |
notificationsSent - Int!
|
|
Arguments
|
|
privatePermalink - String!
|
|
publicPermalink - String!
|
|
publishedAt - ISO8601DateTime
|
|
scheduledAt - ISO8601DateTime
|
|
scheduledAtTimezone - String
|
|
shareImage - Image
|
The share image of the announcement, will be display when this announcement is shared externally |
shouldNotifyPageSubscribers - Boolean
|
Whether the subscribers of the page should be notified when this announcement is published |
slackChannelCount - Int!
|
The number of Slack channels this announcement went to |
slackChannelCounts - Int!
|
The number of Slack channels that the announcement will publish in |
slackChannels - ChannelConnection!
|
|
Arguments
|
|
slackMessage - String
|
The message that is sent to Slack when this announcement is published |
slug - String
|
The slug of the announcement. This is used in the URL, and must be unique within a project |
state - AnnouncementStateEnum
|
The state of the announcement, can be draft, scheduled, published or archived |
subjectLine - String
|
The subject line of the email that is sent when this announcement is published |
subjectLineWithFallback - String
|
|
subscriberCounts - Int!
|
|
Arguments
|
|
subscribers - ProjectSubscriptionConnection!
|
|
Arguments
|
|
template - Template
|
The template that is used to render the announcement if applicable. |
title - String
|
The title of the announcement |
titleWithFallback - String
|
|
totalSubscriberCounts - Int!
|
The total number of subscribers for this announcement across all channels |
updatedAt - ISO8601DateTime!
|
|
videoAsset - VideoAsset
|
The hero video of the announcement |
viewerAnalytics - ViewerAnalyticsObject
|
|
Arguments
|
|
workItems - WorkItemConnection
|
The work items that are associated with this announcement |
Arguments
|
|
Example
{
"archived": false,
"author": "abc123",
"authorWithFallback": "abc123",
"categories": [Category],
"changeTypes": ChangeTypeConnection,
"connectedSources": ConnectedSourceConnection,
"content": "abc123",
"contentGenerators": ContentGeneratorConnection,
"contentHtml": "xyz789",
"contentPlainText": "xyz789",
"contentType": "xyz789",
"createdAt": ISO8601DateTime,
"deactivatedAt": ISO8601DateTime,
"description": "xyz789",
"descriptionWithFallback": "abc123",
"doNotIndex": false,
"emailAnalytics": EmailAnalyticsObject,
"excerpt": "abc123",
"excerptWithFallback": "abc123",
"exportFeedbacks": [Feedback],
"externalContentLinks": [ExternalContentLink],
"feedbackHappyCount": 987,
"feedbackMehCount": 123,
"feedbackSadCount": 987,
"feedbacks": FeedbackConnection,
"hasPendingContentGenerators": false,
"headline": "abc123",
"heroImage": Image,
"id": "4",
"inPublishedDigest": false,
"name": "abc123",
"notificationsExcerptOnly": false,
"notificationsSent": 987,
"privatePermalink": "abc123",
"publicPermalink": "xyz789",
"publishedAt": ISO8601DateTime,
"scheduledAt": ISO8601DateTime,
"scheduledAtTimezone": "xyz789",
"shareImage": Image,
"shouldNotifyPageSubscribers": false,
"slackChannelCount": 987,
"slackChannelCounts": 123,
"slackChannels": ChannelConnection,
"slackMessage": "abc123",
"slug": "xyz789",
"state": "archived",
"subjectLine": "xyz789",
"subjectLineWithFallback": "xyz789",
"subscriberCounts": 987,
"subscribers": ProjectSubscriptionConnection,
"template": Template,
"title": "abc123",
"titleWithFallback": "xyz789",
"totalSubscriberCounts": 987,
"updatedAt": ISO8601DateTime,
"videoAsset": VideoAsset,
"viewerAnalytics": ViewerAnalyticsObject,
"workItems": WorkItemConnection
}
AnnouncementAttachment
Values
| Enum Value | Description |
|---|---|
|
|
heroImage |
|
|
shareImage |
|
|
videoAsset |
Example
"hero_image"
AnnouncementConnection
Description
The connection type for Announcement
Fields
| Field Name | Description |
|---|---|
edges - [AnnouncementEdge!]
|
A list of edges |
nodes - [Announcement]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [AnnouncementEdge],
"nodes": [Announcement],
"pageInfo": PageInfo,
"totalCount": 123
}
AnnouncementDigest
Fields
| Field Name | Description |
|---|---|
announcements - AnnouncementConnection
|
|
Arguments
|
|
categories - [Category!]!
|
|
content - String
|
|
contentHtml - String
|
The HTML representation of the content |
contentPlainText - String
|
The plain text representation of the content |
contentType - String!
|
Defines the type of schema the content follows, draftjs to be deprecated. |
createdAt - ISO8601DateTime!
|
|
deactivatedAt - ISO8601DateTime
|
|
emailClickedThroughCount - Int!
|
|
emailOpenedCount - Int!
|
|
emailSentCount - Int!
|
|
emailSubscriberCount - Int!
|
|
id - ID!
|
|
labels - [ChangeType!]!
|
|
order - [String!]!
|
|
publishedAt - ISO8601DateTime
|
|
slackChannelClickedThroughCount - Int!
|
|
slackChannelCount - Int!
|
|
slackChannelSentCount - Int!
|
|
slackChannels - [Channel!]!
|
|
slackSubscriberClickedThroughCount - Int!
|
|
slackSubscriberCount - Int!
|
|
slackSubscriberSentCount - Int!
|
|
state - AnnouncementDigestStateEnum
|
The state of the digest, can be draft, published or archived |
subjectLine - String
|
|
subscribers - ProjectSubscriptionConnection!
|
|
Arguments
|
|
title - String
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"announcements": AnnouncementConnection,
"categories": [Category],
"content": "abc123",
"contentHtml": "abc123",
"contentPlainText": "abc123",
"contentType": "xyz789",
"createdAt": ISO8601DateTime,
"deactivatedAt": ISO8601DateTime,
"emailClickedThroughCount": 987,
"emailOpenedCount": 987,
"emailSentCount": 987,
"emailSubscriberCount": 123,
"id": "4",
"labels": [ChangeType],
"order": ["xyz789"],
"publishedAt": ISO8601DateTime,
"slackChannelClickedThroughCount": 987,
"slackChannelCount": 987,
"slackChannelSentCount": 987,
"slackChannels": [Channel],
"slackSubscriberClickedThroughCount": 987,
"slackSubscriberCount": 123,
"slackSubscriberSentCount": 987,
"state": "draft",
"subjectLine": "abc123",
"subscribers": ProjectSubscriptionConnection,
"title": "abc123",
"updatedAt": ISO8601DateTime
}
AnnouncementDigestConnection
Description
The connection type for AnnouncementDigest
Fields
| Field Name | Description |
|---|---|
edges - [AnnouncementDigestEdge!]
|
A list of edges |
nodes - [AnnouncementDigest]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [AnnouncementDigestEdge],
"nodes": [AnnouncementDigest],
"pageInfo": PageInfo,
"totalCount": 123
}
AnnouncementDigestEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - AnnouncementDigest
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": AnnouncementDigest
}
AnnouncementDigestStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
Draft |
|
|
Published |
|
|
Archived |
Example
"draft"
AnnouncementEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - Announcement
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": Announcement
}
AnnouncementStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
Archived |
|
|
Draft |
|
|
Scheduled |
|
|
Published |
|
|
Generating |
Example
"archived"
ApiConsumer
Description
An API consumer
Fields
| Field Name | Description |
|---|---|
project - Project!
|
Retrieve a project by ID |
Arguments
|
|
projects - ProjectConnection!
|
|
Arguments
|
|
Example
{
"project": Project,
"projects": ProjectConnection
}
ApiToken
Description
API Token belonging to a project
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
name - String
|
|
token - String!
|
|
type - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": 4,
"name": "xyz789",
"token": "xyz789",
"type": "abc123",
"updatedAt": ISO8601DateTime
}
ApiTokenConnection
Description
The connection type for ApiToken
Fields
| Field Name | Description |
|---|---|
edges - [ApiTokenEdge!]
|
A list of edges |
nodes - [ApiToken]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [ApiTokenEdge],
"nodes": [ApiToken],
"pageInfo": PageInfo,
"totalCount": 987
}
ApiTokenEdge
ApiTokenTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
Management |
|
|
Published |
Example
"ManagementApiUser"
ApiUser
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
email - String!
|
The email of the API user |
id - ID!
|
|
name - String!
|
The name of the API user |
organization - Organization!
|
The owning organization of the API user |
project - Project!
|
Retrieve a project by ID |
Arguments
|
|
projects - ProjectConnection!
|
|
Arguments
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"createdAt": ISO8601DateTime,
"email": "abc123",
"id": "4",
"name": "xyz789",
"organization": Organization,
"project": Project,
"projects": ProjectConnection,
"updatedAt": ISO8601DateTime
}
ArchiveAnnouncementInput
Description
Autogenerated input type of ArchiveAnnouncement
Example
{
"clientMutationId": "abc123",
"announcementId": "4"
}
ArchiveAnnouncementPayload
Description
Autogenerated return type of ArchiveAnnouncement
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
ArchiveFeedbackInput
ArchiveFeedbackPayload
Description
Autogenerated return type of ArchiveFeedback
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
feedback - Feedback
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"feedback": Feedback
}
ArchiveFeedbacksInput
ArchiveFeedbacksPayload
Description
Autogenerated return type of ArchiveFeedbacks
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
feedbacks - [Feedback!]!
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"feedbacks": [Feedback]
}
ArchiveIdeasInput
ArchiveIdeasPayload
Description
Autogenerated return type of ArchiveIdeas
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
ideas - [Idea!]!
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"ideas": [Idea]
}
ArchiveProjectInput
ArchiveProjectPayload
Description
Autogenerated return type of ArchiveProject
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
project - Project
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"project": Project
}
ArchiveStageInput
ArchiveStagePayload
Description
Autogenerated return type of ArchiveStage
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
stage - Stage
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"stage": Stage
}
ArchiveTemplateInput
ArchiveTemplatePayload
Description
Autogenerated return type of ArchiveTemplate
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
template - Template
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"template": Template
}
ArchiveWorkItemInput
ArchiveWorkItemPayload
Description
Autogenerated return type of ArchiveWorkItem
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
workItem - WorkItem
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
Attribute
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
value - AttributeValue
|
Example
{
"key": "xyz789",
"value": AttributeValue
}
AttributeDefinition
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
description - String
|
|
id - ID!
|
|
key - String!
|
|
name - String!
|
|
project - Project!
|
The owning project for this attribute definition |
updatedAt - ISO8601DateTime!
|
|
valueType - Value
|
Example
{
"createdAt": ISO8601DateTime,
"description": "abc123",
"id": 4,
"key": "abc123",
"name": "xyz789",
"project": Project,
"updatedAt": ISO8601DateTime,
"valueType": "string"
}
AttributeDefinitionConnection
Description
The connection type for AttributeDefinition
Fields
| Field Name | Description |
|---|---|
edges - [AttributeDefinitionEdge!]
|
A list of edges |
nodes - [AttributeDefinition]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [AttributeDefinitionEdge],
"nodes": [AttributeDefinition],
"pageInfo": PageInfo,
"totalCount": 123
}
AttributeDefinitionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - AttributeDefinition
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": AttributeDefinition
}
AttributeDefinitionTypeClass
Values
| Enum Value | Description |
|---|---|
|
|
Example
"feedback"
AttributeValue
Description
An attribute value
Example
AttributeValue
AudienceDomain
Fields
| Field Name | Description |
|---|---|
averageFeedbackSentiment - Float
|
|
createdAt - ISO8601DateTime!
|
|
feedbackCount - Int!
|
|
feedbacks - FeedbackConnection!
|
|
Arguments
|
|
firstSeen - ISO8601DateTime!
|
|
hostname - String!
|
|
id - ID!
|
|
name - String
|
|
subscriberCount - Int!
|
|
subscribers - SubscriberConnection!
|
|
Arguments
|
|
updatedAt - ISO8601DateTime!
|
|
voteCount - Int!
|
|
votes - VoteConnection!
|
|
Arguments
|
|
Example
{
"averageFeedbackSentiment": 987.65,
"createdAt": ISO8601DateTime,
"feedbackCount": 987,
"feedbacks": FeedbackConnection,
"firstSeen": ISO8601DateTime,
"hostname": "abc123",
"id": "4",
"name": "xyz789",
"subscriberCount": 123,
"subscribers": SubscriberConnection,
"updatedAt": ISO8601DateTime,
"voteCount": 987,
"votes": VoteConnection
}
AudienceDomainConnection
Description
The connection type for AudienceDomain
Fields
| Field Name | Description |
|---|---|
edges - [AudienceDomainEdge!]
|
A list of edges |
nodes - [AudienceDomain]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [AudienceDomainEdge],
"nodes": [AudienceDomain],
"pageInfo": PageInfo,
"totalCount": 987
}
AudienceDomainEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - AudienceDomain
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": AudienceDomain
}
AuthenticationTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SSO"
BarChartData
Fields
| Field Name | Description |
|---|---|
clicked - Int
|
|
date - ISO8601DateTime!
|
|
opened - Int
|
|
sent - Int
|
Number of emails sent succesfully |
Example
{
"clicked": 123,
"date": ISO8601DateTime,
"opened": 123,
"sent": 123
}
BatchFeedback
Fields
| Input Field | Description |
|---|---|
affectedCustomerEmail - String!
|
|
content - String!
|
|
createdAt - ISO8601DateTime
|
|
importance - Importance
|
|
reaction - Reaction
|
|
reporterEmail - String
|
|
ideaName - String
|
|
ideaNotes - String
|
|
ideaCategories - [String!]
|
|
ideaCreatedAt - ISO8601DateTime
|
|
ideaPublished - Boolean
|
|
internalNote - String
|
Example
{
"affectedCustomerEmail": "abc123",
"content": "abc123",
"createdAt": ISO8601DateTime,
"importance": "low",
"reaction": "happy",
"reporterEmail": "abc123",
"ideaName": "abc123",
"ideaNotes": "xyz789",
"ideaCategories": ["xyz789"],
"ideaCreatedAt": ISO8601DateTime,
"ideaPublished": true,
"internalNote": "abc123"
}
Blob
Boolean
Description
Represents true or false values
Category
Fields
| Field Name | Description |
|---|---|
backgroundColor - String!
|
The background color of the Category, shown on the public page |
color - String!
|
The color of the Category, reflected on the public page |
createdAt - ISO8601DateTime!
|
|
description - String
|
The internal description given to a Category |
id - ID!
|
|
ideas - IdeaConnection
|
A list of all ideas associated with this category |
Arguments
|
|
name - String!
|
The name of the Category (e.g. API, Admin, Enterprise plan) |
position - Int!
|
The position of the Category, relative to the set |
project - Project
|
The project ID the Category is associated to |
slug - String!
|
The API slug of the Category |
textColor - String!
|
The text color of the Category, reflected on the public page |
updatedAt - ISO8601DateTime!
|
|
Example
{
"backgroundColor": "xyz789",
"color": "xyz789",
"createdAt": ISO8601DateTime,
"description": "xyz789",
"id": 4,
"ideas": IdeaConnection,
"name": "abc123",
"position": 987,
"project": Project,
"slug": "abc123",
"textColor": "xyz789",
"updatedAt": ISO8601DateTime
}
CategoryAttributes
Description
Attributes for creating or updating a category
Fields
| Input Field | Description |
|---|---|
projectId - ID
|
|
id - ID
|
|
name - String
|
Name of the announcement |
position - Int
|
Position of category relative to set |
description - String
|
Internal description of the announcement |
color - String
|
Color to use for category display |
textColor - String
|
Text color to use for category display |
backgroundColor - String
|
Background color to use for category display |
Example
{
"projectId": "4",
"id": "4",
"name": "xyz789",
"position": 123,
"description": "xyz789",
"color": "xyz789",
"textColor": "abc123",
"backgroundColor": "xyz789"
}
CategoryConnection
Description
The connection type for Category
Fields
| Field Name | Description |
|---|---|
edges - [CategoryEdge!]
|
A list of edges |
nodes - [Category]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [CategoryEdge],
"nodes": [Category],
"pageInfo": PageInfo,
"totalCount": 123
}
CategoryEdge
ChangeType
Description
A way to indicate the type of change that is being released. Change types are called Labels in the management portal
Fields
| Field Name | Description |
|---|---|
apiSlug - String!
|
The API slug for the Change Type |
color - String!
|
The color of the Change Type |
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
name - String!
|
The name of the Change Type |
project - Project!
|
The project this Change Type belongs to |
updatedAt - ISO8601DateTime!
|
Example
{
"apiSlug": "abc123",
"color": "abc123",
"createdAt": ISO8601DateTime,
"id": 4,
"name": "abc123",
"project": Project,
"updatedAt": ISO8601DateTime
}
ChangeTypeConnection
Description
The connection type for ChangeType
Fields
| Field Name | Description |
|---|---|
edges - [ChangeTypeEdge!]
|
A list of edges |
nodes - [ChangeType]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [ChangeTypeEdge],
"nodes": [ChangeType],
"pageInfo": PageInfo,
"totalCount": 987
}
ChangeTypeEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - ChangeType
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": ChangeType
}
Channel
Fields
| Field Name | Description |
|---|---|
categories - [Category!]!
|
|
channelId - String!
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
name - String!
|
|
updatedAt - ISO8601DateTime!
|
|
workspace - Workspace!
|
Example
{
"categories": [Category],
"channelId": "abc123",
"createdAt": ISO8601DateTime,
"id": 4,
"name": "xyz789",
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
ChannelConnection
Description
The connection type for Channel
Fields
| Field Name | Description |
|---|---|
edges - [ChannelEdge!]
|
A list of edges |
nodes - [Channel]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [ChannelEdge],
"nodes": [Channel],
"pageInfo": PageInfo,
"totalCount": 987
}
ChannelEdge
Cohort
Fields
| Field Name | Description |
|---|---|
allSubscribers - [Subscriber!]!
|
|
audienceDomains - AudienceDomainConnection!
|
|
Arguments
|
|
createdAt - ISO8601DateTime!
|
|
deactivatedAt - ISO8601DateTime
|
|
description - String
|
|
feedbackCount - Int!
|
|
id - ID!
|
|
name - String!
|
|
project - Project!
|
|
subscriberCount - Int!
|
|
subscribers - SubscriberConnection!
|
|
Arguments
|
|
updatedAt - ISO8601DateTime!
|
|
voteCount - Int!
|
|
Example
{
"allSubscribers": [Subscriber],
"audienceDomains": AudienceDomainConnection,
"createdAt": ISO8601DateTime,
"deactivatedAt": ISO8601DateTime,
"description": "xyz789",
"feedbackCount": 123,
"id": "4",
"name": "abc123",
"project": Project,
"subscriberCount": 123,
"subscribers": SubscriberConnection,
"updatedAt": ISO8601DateTime,
"voteCount": 123
}
CohortConnection
Description
The connection type for Cohort
Fields
| Field Name | Description |
|---|---|
edges - [CohortEdge!]
|
A list of edges |
nodes - [Cohort]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [CohortEdge],
"nodes": [Cohort],
"pageInfo": PageInfo,
"totalCount": 123
}
CohortEdge
Comparator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"eq"
ConfirmProjectSubscriptionInput
Description
Autogenerated input type of ConfirmProjectSubscription
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscriptionInput!
|
Input to confirm a project subscription |
Example
{
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscriptionInput
}
ConfirmProjectSubscriptionPayload
Description
Autogenerated return type of ConfirmProjectSubscription
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscription
|
The confirmed project subscription |
Example
{
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscription
}
ConfirmSubscribersInput
ConfirmSubscribersPayload
Description
Autogenerated return type of ConfirmSubscribers
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
subscriberIds - [ID!]
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"subscriberIds": ["4"]
}
ConnectedSource
Fields
| Field Name | Description |
|---|---|
contextId - String
|
Identifier of parent object |
createdAt - ISO8601DateTime!
|
|
externalId - String!
|
Identifier of connected object. Can be used to look up in system |
id - ID!
|
|
metadata - JSON
|
Additional fields of source object |
name - String
|
The name of the connected data source |
providerName - String!
|
The name of the provider source |
updatedAt - ISO8601DateTime!
|
|
url - String!
|
The url of connected source |
Example
{
"contextId": "abc123",
"createdAt": ISO8601DateTime,
"externalId": "xyz789",
"id": "4",
"metadata": {},
"name": "abc123",
"providerName": "xyz789",
"updatedAt": ISO8601DateTime,
"url": "abc123"
}
ConnectedSourceConnection
Description
The connection type for ConnectedSource
Fields
| Field Name | Description |
|---|---|
edges - [ConnectedSourceEdge!]
|
A list of edges |
nodes - [ConnectedSource]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [ConnectedSourceEdge],
"nodes": [ConnectedSource],
"pageInfo": PageInfo,
"totalCount": 123
}
ConnectedSourceEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - ConnectedSource
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": ConnectedSource
}
ContentGenerator
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
inputData - String!
|
|
outputData - String
|
|
status - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"inputData": "abc123",
"outputData": "xyz789",
"status": "abc123",
"updatedAt": ISO8601DateTime
}
ContentGeneratorConnection
Description
The connection type for ContentGenerator
Fields
| Field Name | Description |
|---|---|
edges - [ContentGeneratorEdge!]
|
A list of edges |
nodes - [ContentGenerator]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [ContentGeneratorEdge],
"nodes": [ContentGenerator],
"pageInfo": PageInfo,
"totalCount": 987
}
ContentGeneratorEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - ContentGenerator
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": ContentGenerator
}
CopyAnnouncementToProjectInput
Description
Autogenerated input type of CopyAnnouncementToProject
Example
{
"clientMutationId": "abc123",
"announcementId": "4",
"newProjectId": 4
}
CopyAnnouncementToProjectPayload
Description
Autogenerated return type of CopyAnnouncementToProject
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
targetProject - Project
|
Example
{
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError],
"targetProject": Project
}
CreateAiAnnouncementInput
Description
Autogenerated input type of CreateAiAnnouncement
Example
{
"clientMutationId": "xyz789",
"content": "abc123",
"projectId": "4",
"callbackUrl": "abc123",
"prompt": "xyz789"
}
CreateAiAnnouncementPayload
CreateAnnouncementAttributes
Description
Attributes for creating an announcement
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
headline - String
|
|
contentMarkdown - String
|
|
contentJira - String
|
Jira Wiki Syntax |
contentHtml - String
|
HTML content to be converted |
shouldNotifyPageSubscribers - Boolean
|
|
categories - [CategoryAttributes!]
|
Associated categories of the release |
templateId - ID
|
Pre-fill the announcement with a template. If this is provided, all other input is ignored |
Example
{
"projectId": "4",
"headline": "xyz789",
"contentMarkdown": "xyz789",
"contentJira": "xyz789",
"contentHtml": "xyz789",
"shouldNotifyPageSubscribers": false,
"categories": [CategoryAttributes],
"templateId": 4
}
CreateAnnouncementInput
Description
Autogenerated input type of CreateAnnouncement
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
announcement - CreateAnnouncementAttributes!
|
Example
{
"clientMutationId": "xyz789",
"announcement": CreateAnnouncementAttributes
}
CreateAnnouncementPayload
Description
Autogenerated return type of CreateAnnouncement
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
CreateApiTokenAttributes
Description
Attributes to create a new API Token
Example
{
"projectId": "4",
"name": "xyz789",
"type": "xyz789"
}
CreateApiTokenInput
Description
Autogenerated input type of CreateApiToken
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
apiToken - CreateApiTokenAttributes!
|
Example
{
"clientMutationId": "abc123",
"apiToken": CreateApiTokenAttributes
}
CreateApiTokenPayload
Description
Autogenerated return type of CreateApiToken
Fields
| Field Name | Description |
|---|---|
apiToken - ApiToken
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [String!]!
|
Example
{
"apiToken": ApiToken,
"clientMutationId": "abc123",
"errors": ["xyz789"]
}
CreateAttributeDefinitionAttributes
Description
Attributes to create an attribute definition
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
The attribute definition's project ID |
name - String!
|
The name of the attribute definition |
description - String
|
An optional description to give this attribute definition more context |
key - String!
|
The key used to reference this attribute on it's associated object. This can not be edited after creation |
valueType - Value!
|
The data type of the value |
typeClass - AttributeDefinitionTypeClass!
|
The type of object this attribute definition will be associated with |
Example
{
"projectId": 4,
"name": "xyz789",
"description": "xyz789",
"key": "abc123",
"valueType": "string",
"typeClass": "feedback"
}
CreateAttributeDefinitionInput
Description
Autogenerated input type of CreateAttributeDefinition
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
attributeDefinition - CreateAttributeDefinitionAttributes!
|
Example
{
"clientMutationId": "xyz789",
"attributeDefinition": CreateAttributeDefinitionAttributes
}
CreateAttributeDefinitionPayload
Description
Autogenerated return type of CreateAttributeDefinition
Fields
| Field Name | Description |
|---|---|
attributeDefinition - AttributeDefinition
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"attributeDefinition": AttributeDefinition,
"clientMutationId": "abc123",
"errors": [UserError]
}
CreateAttributes
Description
Attributes for creating a subscription
Fields
| Input Field | Description |
|---|---|
eventTypes - [EventTypeAttributes!]
|
Event types you would like receive notifications on |
categories - [CategoryAttributes!]
|
Associated categories of the announcement |
subscribedObject - SubscribedObjectAttributes
|
The project or announcement you would like to create a subscription for |
subscriber - SubscriberAttributes!
|
The owner of the subscription |
type - SubscriptionTypes
|
The type of subscription - eg. SimpleMailApp or SlackApp |
skipOptIn - Boolean
|
If set to true, opt in a newly created subscriber without sending a confirmation email |
Example
{
"eventTypes": [EventTypeAttributes],
"categories": [CategoryAttributes],
"subscribedObject": SubscribedObjectAttributes,
"subscriber": SubscriberAttributes,
"type": "SimpleMailApp",
"skipOptIn": true
}
CreateCategoryAttributes
Description
Attributes to create a project category
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
The category's project ID |
name - String!
|
The name of the category. This will be used to generate its unique slug |
description - String
|
An optional description to give this category more context |
color - String
|
Used to generate the text and background colors when rendered throughout LaunchNotes. Will be randomly selected if left blank |
Example
{
"projectId": "4",
"name": "abc123",
"description": "abc123",
"color": "abc123"
}
CreateCategoryInput
Description
Autogenerated input type of CreateCategory
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
category - CreateCategoryAttributes!
|
Example
{
"clientMutationId": "abc123",
"category": CreateCategoryAttributes
}
CreateCategoryPayload
Description
Autogenerated return type of CreateCategory
Fields
| Field Name | Description |
|---|---|
category - Category
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"category": Category,
"clientMutationId": "abc123",
"errors": [UserError]
}
CreateChangeInput
Description
Autogenerated input type of CreateChange
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
changeType - CreateChangeTypeAttributes!
|
Example
{
"clientMutationId": "xyz789",
"changeType": CreateChangeTypeAttributes
}
CreateChangePayload
Description
Autogenerated return type of CreateChange
Fields
| Field Name | Description |
|---|---|
changeType - ChangeType
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"changeType": ChangeType,
"clientMutationId": "abc123",
"errors": [UserError]
}
CreateChangeTypeAttributes
Description
Attributes to create a project change type
Example
{
"projectId": "4",
"name": "abc123",
"color": "abc123"
}
CreateDirectUploadInput
Description
Autogenerated input type of CreateDirectUpload
Example
{
"clientMutationId": "abc123",
"filename": "abc123",
"byteSize": 123,
"checksum": "xyz789",
"contentType": "xyz789"
}
CreateDirectUploadPayload
CreateExternalContentLinkInput
Description
Autogenerated input type of CreateExternalContentLink
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
externalContentLink - CreateLinkAttributes!
|
Example
{
"clientMutationId": "xyz789",
"externalContentLink": CreateLinkAttributes
}
CreateExternalContentLinkPayload
Description
Autogenerated return type of CreateExternalContentLink
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
stage - Stage
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"stage": Stage
}
CreateFeedbackAttributes
Description
Attributes for creating a feedback
Example
{
"projectId": "4",
"affectedCustomerEmail": "abc123",
"reaction": "happy",
"importance": "low",
"content": "xyz789",
"notes": "abc123",
"feedbackableId": "4",
"feedbackableType": "xyz789",
"origin": "xyz789"
}
CreateFeedbackInput
Description
Autogenerated input type of CreateFeedback
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
feedback - CreateFeedbackAttributes!
|
Example
{
"clientMutationId": "xyz789",
"feedback": CreateFeedbackAttributes
}
CreateFeedbackPayload
Description
Autogenerated return type of CreateFeedback
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
feedback - Feedback
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"feedback": Feedback
}
CreateIdeaInput
Description
Autogenerated input type of CreateIdea
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectId - ID!
|
|
name - String!
|
|
notes - String
|
|
categories - [CategoryAttributes!]
|
Associated categories of the idea |
Example
{
"clientMutationId": "abc123",
"projectId": 4,
"name": "xyz789",
"notes": "abc123",
"categories": [CategoryAttributes]
}
CreateIdeaPayload
Description
Autogenerated return type of CreateIdea
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
idea - Idea
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"idea": Idea
}
CreateLinkAttributes
CreateOrganizationProfileInput
Description
Autogenerated input type of CreateOrganizationProfile
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
name - String!
|
|
creatorId - ID!
|
|
userRole - UserRoleEnum!
|
|
userReferralSource - UserReferralSourceEnum!
|
Example
{
"clientMutationId": "xyz789",
"name": "abc123",
"creatorId": "4",
"userRole": "all",
"userReferralSource": "search_engine"
}
CreateOrganizationProfilePayload
Description
Autogenerated return type of CreateOrganizationProfile
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]
|
|
projectId - ID!
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"projectId": "4"
}
CreateProjectInput
Description
Autogenerated input type of CreateProject
Example
{
"clientMutationId": "xyz789",
"name": "xyz789",
"organizationId": "abc123"
}
CreateProjectPayload
Description
Autogenerated return type of CreateProject
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
project - Project
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"project": Project
}
CreateProjectSubscriptionAttributes
Description
Attributes for creating a subscription
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
The project id to create a subscription for |
subscriber - SubscriberAttributes!
|
The subscription owner |
workItems - [WorkItemAttributes!]
|
Subscribed work items |
categories - [CategoryAttributes!]
|
Subscribed categories |
skipOptIn - Boolean
|
If set to true, opt in a newly created subscriber without sending a confirmation email |
Example
{
"projectId": 4,
"subscriber": SubscriberAttributes,
"workItems": [WorkItemAttributes],
"categories": [CategoryAttributes],
"skipOptIn": true
}
CreateProjectSubscriptionInput
Description
Autogenerated input type of CreateProjectSubscription
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - CreateProjectSubscriptionAttributes!
|
Example
{
"clientMutationId": "xyz789",
"projectSubscription": CreateProjectSubscriptionAttributes
}
CreateProjectSubscriptionPayload
Description
Autogenerated return type of CreateProjectSubscription
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
projectSubscription - ProjectSubscription
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"projectSubscription": ProjectSubscription
}
CreateRoadmapUpdateAttributes
Description
Attributes for creating an update for a work_item
Example
{
"title": "abc123",
"content": "xyz789",
"newStageId": 4,
"workItemId": "4",
"internalOnly": true
}
CreateRoadmapUpdateInput
Description
Autogenerated input type of CreateRoadmapUpdate
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
roadmapUpdate - CreateRoadmapUpdateAttributes!
|
Example
{
"clientMutationId": "abc123",
"roadmapUpdate": CreateRoadmapUpdateAttributes
}
CreateRoadmapUpdatePayload
Description
Autogenerated return type of CreateRoadmapUpdate
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]
|
|
roadmapUpdate - RoadmapUpdate
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"roadmapUpdate": RoadmapUpdate
}
CreateSecureConnectionInput
Description
Autogenerated input type of CreateSecureConnection
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectId - ID!
|
The ID of the project you would like the create the secure connection on |
authenticationType - AuthenticationTypeEnum!
|
The type of secure connection you would like to create |
Example
{
"clientMutationId": "abc123",
"projectId": 4,
"authenticationType": "SSO"
}
CreateSecureConnectionPayload
Description
Autogenerated return type of CreateSecureConnection
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError]
}
CreateStageAttributes
Description
Attributes for creating a stage
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
The project you are creating this stage on |
name - String!
|
The name of the stage |
description - String
|
A description of the stage |
published - Boolean
|
Whether or not the stage is published to your roadmap |
archiveAfterDays - Int
|
If specified, automatically archive work items after N days in this stage |
Example
{
"projectId": "4",
"name": "abc123",
"description": "xyz789",
"published": false,
"archiveAfterDays": 987
}
CreateStageInput
Description
Autogenerated input type of CreateStage
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
stage - CreateStageAttributes!
|
Example
{
"clientMutationId": "abc123",
"stage": CreateStageAttributes
}
CreateStagePayload
Description
Autogenerated return type of CreateStage
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
stage - Stage
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"stage": Stage
}
CreateSubscriptionInput
Description
Autogenerated input type of CreateSubscription
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
subscription - CreateAttributes!
|
Example
{
"clientMutationId": "xyz789",
"subscription": CreateAttributes
}
CreateSubscriptionPayload
Description
Autogenerated return type of CreateSubscription
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
subscription - Subscription
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"subscription": Subscription
}
CreateTemplateAttributes
Description
Attributes for creating a template
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
The project you are creating this template on |
marketplaceTemplateId - ID
|
The marketplace template you are basing the template on |
name - String
|
The name of the template |
description - String
|
A description of the template |
headline - String
|
The headline of the announcement |
content - String
|
The content of the announcement |
excerpt - String
|
The excerpt of the announcement |
categories - [CategoryAttributes!]
|
Associated categories of the release |
workItems - [WorkItemAttributes!]
|
Associated categories |
Example
{
"projectId": "4",
"marketplaceTemplateId": "4",
"name": "xyz789",
"description": "abc123",
"headline": "xyz789",
"content": "xyz789",
"excerpt": "abc123",
"categories": [CategoryAttributes],
"workItems": [WorkItemAttributes]
}
CreateTemplateInput
Description
Autogenerated input type of CreateTemplate
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
template - CreateTemplateAttributes!
|
Example
{
"clientMutationId": "abc123",
"template": CreateTemplateAttributes
}
CreateTemplatePayload
Description
Autogenerated return type of CreateTemplate
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
template - Template
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"template": Template
}
CreateWorkItemAttributes
Description
Attributes for creating a work_item
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the work item |
content - String
|
A description of the work item |
contentJira - String
|
Jira Wiki Syntax |
contentHtml - String
|
HTML Content to be converted |
contentMarkdown - String
|
Markdown content to be converted |
categories - [CategoryAttributes!]
|
Associated categories of the work item |
stageId - ID!
|
What stage you would like the work item to be added to |
ownerId - ID
|
The owner for the work item |
Example
{
"name": "abc123",
"content": "xyz789",
"contentJira": "abc123",
"contentHtml": "abc123",
"contentMarkdown": "abc123",
"categories": [CategoryAttributes],
"stageId": 4,
"ownerId": 4
}
CreateWorkItemInput
Description
Autogenerated input type of CreateWorkItem
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
workItem - CreateWorkItemAttributes!
|
Example
{
"clientMutationId": "xyz789",
"workItem": CreateWorkItemAttributes
}
CreateWorkItemMovedUpdateInput
Description
Autogenerated input type of CreateWorkItemMovedUpdate
Example
{
"clientMutationId": "xyz789",
"workItemId": 4,
"isTestEmail": false
}
CreateWorkItemMovedUpdatePayload
Description
Autogenerated return type of CreateWorkItemMovedUpdate
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]
|
|
success - Boolean
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"success": false
}
CreateWorkItemPayload
Description
Autogenerated return type of CreateWorkItem
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
workItem - WorkItem
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
DeleteAttributeDefinitionInput
DeleteAttributeDefinitionPayload
Description
Autogenerated return type of DeleteAttributeDefinition
Fields
| Field Name | Description |
|---|---|
attributeDefinition - AttributeDefinition
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"attributeDefinition": AttributeDefinition,
"clientMutationId": "abc123",
"errors": [UserError]
}
DeleteExternalContentLinkInput
DeleteExternalContentLinkPayload
Description
Autogenerated return type of DeleteExternalContentLink
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
stage - Stage
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"stage": Stage
}
DestroyUserAccountInput
DestroyUserAccountPayload
Description
Autogenerated return type of DestroyUserAccount
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
user - User
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"user": User
}
DuplicateAnnouncementInput
DuplicateAnnouncementPayload
Description
Autogenerated return type of DuplicateAnnouncement
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
EmailAnalyticsObject
Fields
| Field Name | Description |
|---|---|
chartData - [BarChartData!]!
|
|
clickRate - Float!
|
|
clickToOpenRate - Float!
|
|
openRate - Float!
|
|
sentCount - Float!
|
Number of emails sent |
Example
{
"chartData": [BarChartData],
"clickRate": 987.65,
"clickToOpenRate": 987.65,
"openRate": 987.65,
"sentCount": 987.65
}
EmbedApp
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
enforceToken - Boolean!
|
|
id - ID!
|
|
name - String!
|
|
settings - JSON
|
Additional settings for the embed app |
subtitle - String!
|
|
token - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"enforceToken": false,
"id": 4,
"name": "abc123",
"settings": {},
"subtitle": "xyz789",
"token": "xyz789",
"updatedAt": ISO8601DateTime
}
Event
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
data - JSON
|
More details about the event, will vary based on the event type |
eventObject - EventObjectUnion
|
The object that was affected by the event |
eventType - String!
|
The type of the event |
id - ID!
|
|
internalOnly - Boolean!
|
|
notifications - NotificationConnection
|
|
Arguments
|
|
processingCompletedAt - ISO8601DateTime
|
|
processingStartedAt - ISO8601DateTime
|
|
project - Project!
|
The project that the event belongs to |
updatedAt - ISO8601DateTime!
|
|
user - EventUser
|
The user that triggered the event |
userData - JSON!
|
More details about the acting user, will vary based on the event type |
Example
{
"createdAt": ISO8601DateTime,
"data": {},
"eventObject": Announcement,
"eventType": "abc123",
"id": "4",
"internalOnly": false,
"notifications": NotificationConnection,
"processingCompletedAt": ISO8601DateTime,
"processingStartedAt": ISO8601DateTime,
"project": Project,
"updatedAt": ISO8601DateTime,
"user": Subscriber,
"userData": {}
}
EventConnection
Description
The connection type for Event
Fields
| Field Name | Description |
|---|---|
edges - [EventEdge!]
|
A list of edges |
nodes - [Event]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [EventEdge],
"nodes": [Event],
"pageInfo": PageInfo,
"totalCount": 987
}
EventEdge
EventObjectUnion
Description
Represents that possible types of objects that can be associated with an event
Example
Announcement
EventType
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
name - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": 4,
"name": "abc123",
"updatedAt": ISO8601DateTime
}
EventTypeAttributes
EventTypeConnection
Description
The connection type for EventType
Fields
| Field Name | Description |
|---|---|
edges - [EventTypeEdge!]
|
A list of edges |
nodes - [EventType]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [EventTypeEdge],
"nodes": [EventType],
"pageInfo": PageInfo,
"totalCount": 987
}
EventTypeEdge
EventUser
Description
Represents the possible types of users on an event
Types
| Union Types |
|---|
Example
Subscriber
ExternalContentLink
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
imageUrl - String
|
The URL of the image for this Link |
owner - WorkItem!
|
The owning Work Item for this Link |
title - String!
|
The title of the Link |
updatedAt - ISO8601DateTime!
|
|
url - String!
|
The destination URL for this Link |
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"imageUrl": "xyz789",
"owner": WorkItem,
"title": "abc123",
"updatedAt": ISO8601DateTime,
"url": "xyz789"
}
Feedback
Fields
| Field Name | Description |
|---|---|
affectedCustomer - Subscriber!
|
|
affectedCustomerEmail - String!
|
The subscriber who reported this but, or who had it reported on their behalf |
archived - Boolean!
|
Whether or not this feedback is archived |
attributes - [Attribute!]!
|
|
canFollowUp - Boolean!
|
canFollowUp will not be supported in Feedback v2. |
canUseTestimonial - Boolean
|
canUseTestimonial will not be supported in Feedback v2. |
content - String!
|
Content body of the feedback |
createdAt - ISO8601DateTime!
|
|
feedbackable - Feedbackable
|
The object that this feedback relates to (announcement, roadmap item, or idea) |
id - ID!
|
|
idea - Idea
|
Ideas should be associated as Feedbackable objects instead of directly via the ID |
importance - Importance
|
Perceived importance of this feedback (high, medium, low) |
notes - String
|
Additional context, left by the reporter on behalf of the affected customer |
project - Project!
|
The owning project for this feedback |
reaction - Reaction
|
Reaction sentiment of this feedback (happy, meh, or sad) |
reporter - User
|
The support agent that logged this feedback |
sentimentMagnitude - Float
|
The sentiment magnitude of the feedback |
sentimentScore - Float
|
The sentiment score of the feedback |
starred - Boolean!
|
Starred will not be supported in Feedback v2. |
updatedAt - ISO8601DateTime!
|
Example
{
"affectedCustomer": Subscriber,
"affectedCustomerEmail": "xyz789",
"archived": true,
"attributes": [Attribute],
"canFollowUp": false,
"canUseTestimonial": true,
"content": "abc123",
"createdAt": ISO8601DateTime,
"feedbackable": Feedbackable,
"id": 4,
"idea": Idea,
"importance": "low",
"notes": "abc123",
"project": Project,
"reaction": "happy",
"reporter": User,
"sentimentMagnitude": 987.65,
"sentimentScore": 123.45,
"starred": false,
"updatedAt": ISO8601DateTime
}
FeedbackConnection
Description
The connection type for Feedback
Fields
| Field Name | Description |
|---|---|
edges - [FeedbackEdge!]
|
A list of edges |
nodes - [Feedback]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [FeedbackEdge],
"nodes": [Feedback],
"pageInfo": PageInfo,
"totalCount": 987
}
FeedbackEdge
Feedbackable
Float
Description
Represents signed double-precision fractional values as specified by IEEE 754
Example
987.65
HasAttributeDefinitions
Fields
| Field Name | Description |
|---|---|
attributeDefinitions - AttributeDefinitionConnection!
|
|
Arguments
|
|
id - ID!
|
|
Possible Types
| HasAttributeDefinitions Types |
|---|
Example
{
"attributeDefinitions": AttributeDefinitionConnection,
"id": 4
}
HasAttributes
Fields
| Field Name | Description |
|---|---|
attributes - [Attribute!]!
|
|
id - ID!
|
Possible Types
| HasAttributes Types |
|---|
Example
{
"attributes": [Attribute],
"id": "4"
}
HasContentGenerators
Fields
| Field Name | Description |
|---|---|
contentGenerators - ContentGeneratorConnection
|
|
Arguments
|
|
hasPendingContentGenerators - Boolean
|
If there are any content generators in a pending or generating state |
Possible Types
| HasContentGenerators Types |
|---|
Example
{
"contentGenerators": ContentGeneratorConnection,
"hasPendingContentGenerators": false
}
HasFeedbacks
Fields
| Field Name | Description |
|---|---|
exportFeedbacks - [Feedback!]
|
|
feedbackHappyCount - Int!
|
|
feedbackMehCount - Int!
|
|
feedbackSadCount - Int!
|
|
feedbacks - FeedbackConnection
|
|
Arguments
|
|
id - ID!
|
|
Possible Types
| HasFeedbacks Types |
|---|
Example
{
"exportFeedbacks": [Feedback],
"feedbackHappyCount": 123,
"feedbackMehCount": 987,
"feedbackSadCount": 123,
"feedbacks": FeedbackConnection,
"id": "4"
}
HubspotApp
Fields
| Field Name | Description |
|---|---|
accountId - String
|
The ID of the HubSpot account |
createdAt - ISO8601DateTime!
|
|
description - String!
|
Description of the app |
emailSubscriptionId - String
|
The ID of the email subscription list in HubSpot |
emailSubscriptionName - String
|
The name of the email subscription list in HubSpot |
emailSubscriptions - [HubspotEmailSubscription!]
|
Email subscriptions available in HubSpot |
emailTemplateId - String
|
The ID of the template in HubSpot to be used for announcements |
emailTemplateName - String
|
The name of the template in HubSpot to be used for announcements |
id - ID!
|
|
markedForDeletion - Boolean!
|
Whether the app is marked for deletion |
name - String!
|
Name of the app |
project - Project!
|
|
ready - Boolean!
|
Whether the app has all required settings configured |
replyToEmail - String
|
The reply-to email address in HubSpot |
sendEmailViaHubspot - Boolean
|
|
syncing - Boolean!
|
Indicates if there is an active job syncing your HubSpot data |
templates - [HubspotTemplate!]
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"accountId": "xyz789",
"createdAt": ISO8601DateTime,
"description": "xyz789",
"emailSubscriptionId": "abc123",
"emailSubscriptionName": "xyz789",
"emailSubscriptions": [HubspotEmailSubscription],
"emailTemplateId": "xyz789",
"emailTemplateName": "abc123",
"id": 4,
"markedForDeletion": true,
"name": "abc123",
"project": Project,
"ready": true,
"replyToEmail": "abc123",
"sendEmailViaHubspot": false,
"syncing": true,
"templates": [HubspotTemplate],
"updatedAt": ISO8601DateTime
}
HubspotEmailSubscription
HubspotTemplate
ID
Description
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID
Example
4
ISO8601DateTime
Description
An ISO 8601-encoded datetime
Example
ISO8601DateTime
Idea
Fields
| Field Name | Description |
|---|---|
archived - Boolean!
|
|
categories - CategoryConnection
|
A list of all categories associated with this idea |
Arguments
|
|
createdAt - ISO8601DateTime!
|
|
deactivatedAt - ISO8601DateTime
|
Date item was deactivated at. Item will be found in archive views once deactivated |
emailPromotionCount - Int!
|
The number of emails that will be sent if an idea is promoted |
exportFeedbacks - [Feedback!]
|
|
feedbackCount - Int!
|
The number of feedbacks associated with this idea |
feedbackHappyCount - Int!
|
|
feedbackMehCount - Int!
|
|
feedbackSadCount - Int!
|
|
feedbacks - FeedbackConnection
|
|
Arguments
|
|
id - ID!
|
|
ideaVotesCount - Int!
|
The number of votes associated with this idea |
lastFeedback - ISO8601DateTime
|
Idea#updated_at updates when feedback is added to an idea. |
latestWorkItemId - String
|
|
name - String!
|
The name of the Idea |
notes - String
|
Detailed notes describing the idea |
privatePermalink - String!
|
|
project - Project
|
The project ID the Category is associated to |
publicPermalink - String!
|
|
published - Boolean!
|
Published ideas will be displayed on your LaunchNotes Page |
updatedAt - ISO8601DateTime!
|
|
votes - VoteConnection
|
A list of all votes associated with this idea |
Arguments
|
|
Example
{
"archived": true,
"categories": CategoryConnection,
"createdAt": ISO8601DateTime,
"deactivatedAt": ISO8601DateTime,
"emailPromotionCount": 123,
"exportFeedbacks": [Feedback],
"feedbackCount": 987,
"feedbackHappyCount": 987,
"feedbackMehCount": 123,
"feedbackSadCount": 123,
"feedbacks": FeedbackConnection,
"id": 4,
"ideaVotesCount": 123,
"lastFeedback": ISO8601DateTime,
"latestWorkItemId": "abc123",
"name": "abc123",
"notes": "xyz789",
"privatePermalink": "xyz789",
"project": Project,
"publicPermalink": "xyz789",
"published": true,
"updatedAt": ISO8601DateTime,
"votes": VoteConnection
}
IdeaConnection
Description
The connection type for Idea
Fields
| Field Name | Description |
|---|---|
edges - [IdeaEdge!]
|
A list of edges |
nodes - [Idea]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [IdeaEdge],
"nodes": [Idea],
"pageInfo": PageInfo,
"totalCount": 123
}
IdeaEdge
IdeaVote
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
idea - Idea!
|
|
subscriber - Subscriber!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"idea": Idea,
"subscriber": Subscriber,
"updatedAt": ISO8601DateTime
}
IdeaVoteConnection
Description
The connection type for IdeaVote
Fields
| Field Name | Description |
|---|---|
edges - [IdeaVoteEdge!]
|
A list of edges |
nodes - [IdeaVote]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [IdeaVoteEdge],
"nodes": [IdeaVote],
"pageInfo": PageInfo,
"totalCount": 123
}
IdeaVoteEdge
Image
ImportFeedbackInput
Description
Autogenerated input type of ImportFeedback
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
feedbacks - [BatchFeedback!]!
|
|
projectId - ID!
|
|
skipOptIn - Boolean
|
Example
{
"clientMutationId": "abc123",
"feedbacks": [BatchFeedback],
"projectId": 4,
"skipOptIn": false
}
ImportFeedbackPayload
Description
Autogenerated return type of ImportFeedback
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
status - String
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"status": "xyz789"
}
Importance
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"low"
Int
Description
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1
Example
987
JSON
Description
Represents untyped JSON
Example
{}
MailAppSetting
Fields
| Field Name | Description |
|---|---|
activeEsp - String
|
|
announcementButtonCta - String
|
|
apiKey - String
|
|
bodyBackgroundColor - String
|
|
categoriesEnabled - Boolean
|
Whether or not categories are shown in emails |
containerBackgroundColor - String
|
|
courierBrandId - String
|
Courier is no longer supported |
createdAt - ISO8601DateTime!
|
|
customLayout - String
|
|
digestBackgroundColor - String
|
|
digestTextColor - String
|
|
domain - String
|
|
euDomain - Boolean!
|
|
fontFamily - String
|
|
headingColor - String
|
|
id - ID!
|
|
logo - Image
|
|
logoHeight - String
|
|
notificationsExcerptOnly - Boolean!
|
|
primaryColor - String
|
|
replyToEmail - String
|
|
senderName - String
|
|
smtpHost - String
|
|
smtpPassword - String
|
|
smtpPort - String
|
|
smtpSecure - Boolean
|
|
smtpUser - String
|
|
subscriberConfirmButtonCta - String
|
|
superscriptColor - String
|
|
textColor - String
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"activeEsp": "abc123",
"announcementButtonCta": "xyz789",
"apiKey": "xyz789",
"bodyBackgroundColor": "xyz789",
"categoriesEnabled": false,
"containerBackgroundColor": "abc123",
"courierBrandId": "xyz789",
"createdAt": ISO8601DateTime,
"customLayout": "xyz789",
"digestBackgroundColor": "xyz789",
"digestTextColor": "xyz789",
"domain": "xyz789",
"euDomain": false,
"fontFamily": "abc123",
"headingColor": "xyz789",
"id": "4",
"logo": Image,
"logoHeight": "abc123",
"notificationsExcerptOnly": false,
"primaryColor": "abc123",
"replyToEmail": "abc123",
"senderName": "xyz789",
"smtpHost": "xyz789",
"smtpPassword": "abc123",
"smtpPort": "abc123",
"smtpSecure": false,
"smtpUser": "xyz789",
"subscriberConfirmButtonCta": "xyz789",
"superscriptColor": "xyz789",
"textColor": "abc123",
"updatedAt": ISO8601DateTime
}
MarketplaceTemplate
Description
A marketplace template
Fields
| Field Name | Description |
|---|---|
category - String
|
|
coverImage - Image
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
name - String
|
|
position - Int!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"category": "abc123",
"coverImage": Image,
"createdAt": ISO8601DateTime,
"id": 4,
"name": "xyz789",
"position": 987,
"updatedAt": ISO8601DateTime
}
MarketplaceTemplateConnection
Description
The connection type for MarketplaceTemplate
Fields
| Field Name | Description |
|---|---|
edges - [MarketplaceTemplateEdge!]
|
A list of edges |
nodes - [MarketplaceTemplate]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [MarketplaceTemplateEdge],
"nodes": [MarketplaceTemplate],
"pageInfo": PageInfo,
"totalCount": 987
}
MarketplaceTemplateEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - MarketplaceTemplate
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": MarketplaceTemplate
}
Node
Description
An object with an ID
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the object |
Possible Types
| Node Types |
|---|
Example
{"id": 4}
Notification
Fields
| Field Name | Description |
|---|---|
clickedThroughAt - ISO8601DateTime
|
The time the notification was clicked |
createdAt - ISO8601DateTime!
|
|
deliveredAt - ISO8601DateTime
|
Delivered at is no longer supported |
event - Event!
|
|
id - ID!
|
|
openedAt - ISO8601DateTime
|
The time the notification was opened |
sentAt - ISO8601DateTime
|
The time the notification was sent |
status - NotificationStatus!
|
The status of the notification, clicked, opened, sent or undelivered |
transport - SubscriptionTransport!
|
The transport used to send the notification, email or slack |
updatedAt - ISO8601DateTime!
|
Example
{
"clickedThroughAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"deliveredAt": ISO8601DateTime,
"event": Event,
"id": "4",
"openedAt": ISO8601DateTime,
"sentAt": ISO8601DateTime,
"status": "clicked",
"transport": SimpleMailTransport,
"updatedAt": ISO8601DateTime
}
NotificationConnection
Description
The connection type for Notification
Fields
| Field Name | Description |
|---|---|
edges - [NotificationEdge!]
|
A list of edges |
nodes - [Notification]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [NotificationEdge],
"nodes": [Notification],
"pageInfo": PageInfo,
"totalCount": 987
}
NotificationEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - Notification
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": Notification
}
NotificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"clicked"
OnboardingTasks
Fields
| Field Name | Description |
|---|---|
addAnnouncement - Boolean
|
|
addSubscriber - Boolean
|
|
addUser - Boolean
|
|
addWorkItem - Boolean
|
|
claimSubdomain - Boolean
|
|
createdAt - ISO8601DateTime!
|
|
customizeCategories - Boolean
|
|
customizeColors - Boolean
|
|
customizeEmail - Boolean
|
|
customizeHtmlCss - Boolean
|
|
customizeRoadmapStages - Boolean
|
|
enableRoadmap - Boolean
|
|
id - ID!
|
|
updatedAt - ISO8601DateTime!
|
|
uploadLogo - Boolean
|
Example
{
"addAnnouncement": false,
"addSubscriber": true,
"addUser": false,
"addWorkItem": false,
"claimSubdomain": true,
"createdAt": ISO8601DateTime,
"customizeCategories": true,
"customizeColors": true,
"customizeEmail": true,
"customizeHtmlCss": true,
"customizeRoadmapStages": false,
"enableRoadmap": true,
"id": 4,
"updatedAt": ISO8601DateTime,
"uploadLogo": false
}
OrderBy
Fields
| Input Field | Description |
|---|---|
field - String!
|
|
sort - SortEnum!
|
|
type - OrderByField
|
Example
{
"field": "xyz789",
"sort": "DESC",
"type": "string"
}
OrderByField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"string"
Organization
Fields
| Field Name | Description |
|---|---|
activeTier - String
|
The active tier of the Organization |
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
name - String
|
The name of the Organization |
projects - [Project!]
|
The projects associated with the Organization |
trial - Boolean
|
The trial status of the Organization |
updatedAt - ISO8601DateTime!
|
|
users - [User!]!
|
The users associated with the Organization |
Example
{
"activeTier": "abc123",
"createdAt": ISO8601DateTime,
"id": 4,
"name": "xyz789",
"projects": [Project],
"trial": false,
"updatedAt": ISO8601DateTime,
"users": [User]
}
OrganizeFeedbacksInput
Description
Autogenerated input type of OrganizeFeedbacks
Example
{
"clientMutationId": "xyz789",
"feedbackIds": [4],
"feedbackableId": "4",
"feedbackableType": "abc123"
}
OrganizeFeedbacksPayload
Description
Autogenerated return type of OrganizeFeedbacks
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
feedbacks - [Feedback!]
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"feedbacks": [Feedback]
}
OutboundWebhook
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
enabled - Boolean!
|
Whether or not the webhook is active |
eventTypes - [EventType!]!
|
|
events - OutboundWebhookEventConnection!
|
|
Arguments
|
|
id - ID!
|
|
managed - Boolean
|
Whether or not the webhook is managed by the system or user |
name - String!
|
The given name of the webhook |
owner - WebhookOwner!
|
The owner of the webhook |
password - String
|
The password for authorizing the webhook |
status - OutboundWebhookStatus!
|
The current validity state of the webhook |
updatedAt - ISO8601DateTime!
|
|
url - String!
|
The URL that the webhook sends information to |
username - String
|
The username for authorizing the webhook |
Example
{
"createdAt": ISO8601DateTime,
"enabled": false,
"eventTypes": [EventType],
"events": OutboundWebhookEventConnection,
"id": 4,
"managed": true,
"name": "xyz789",
"owner": Organization,
"password": "abc123",
"status": "pending",
"updatedAt": ISO8601DateTime,
"url": "xyz789",
"username": "abc123"
}
OutboundWebhookEvent
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
event - Event!
|
|
eventType - EventType!
|
|
id - ID!
|
|
outboundWebhook - OutboundWebhook!
|
|
payload - JSON!
|
|
status - OutboundWebhookEventStatus!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"event": Event,
"eventType": EventType,
"id": 4,
"outboundWebhook": OutboundWebhook,
"payload": {},
"status": "pending",
"updatedAt": ISO8601DateTime
}
OutboundWebhookEventConnection
Description
The connection type for OutboundWebhookEvent
Fields
| Field Name | Description |
|---|---|
edges - [OutboundWebhookEventEdge!]
|
A list of edges |
nodes - [OutboundWebhookEvent]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [OutboundWebhookEventEdge],
"nodes": [OutboundWebhookEvent],
"pageInfo": PageInfo,
"totalCount": 987
}
OutboundWebhookEventEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - OutboundWebhookEvent
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": OutboundWebhookEvent
}
OutboundWebhookEventStatus
Values
| Enum Value | Description |
|---|---|
|
|
Waiting to be sent |
|
|
The URL of the webhook accepted the event |
|
|
The webhook attempted and retried delivery but was unsuccessful |
|
|
The webhook failed a previous attempt but is being retried |
Example
"pending"
OutboundWebhookStatus
Values
| Enum Value | Description |
|---|---|
|
|
Webhook has yet to check status |
|
|
Webhook has been verified |
|
|
Webhook failed validation |
Example
"pending"
Owner
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"User"
PageInfo
Description
Information about pagination in a connection
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
Permalinks
Possible Types
| Permalinks Types |
|---|
Example
{
"privatePermalink": "xyz789",
"publicPermalink": "xyz789"
}
PreviewAnnouncementSlackInput
Description
Autogenerated input type of PreviewAnnouncementSlack
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
announcementId - ID!
|
The id of the announcement you would like to schedule. Announcement must be a draft, or scheduled |
recipientEmail - String!
|
The email you want to send this announcement preview to |
Example
{
"clientMutationId": "xyz789",
"announcementId": 4,
"recipientEmail": "xyz789"
}
PreviewAnnouncementSlackPayload
Description
Autogenerated return type of PreviewAnnouncementSlack
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
Project
Description
A project
Fields
| Field Name | Description |
|---|---|
allowedDomains - [String!]!
|
|
announcementDigests - AnnouncementDigestConnection!
|
|
Arguments
|
|
announcements - AnnouncementConnection
|
|
Arguments
|
|
apiToken - ApiToken
|
Retrieve an API Token by ID |
Arguments
|
|
apiTokens - ApiTokenConnection
|
|
Arguments
|
|
attributeDefinitions - AttributeDefinitionConnection!
|
|
Arguments
|
|
audienceDomain - AudienceDomain
|
|
Arguments
|
|
audienceDomains - AudienceDomainConnection!
|
|
Arguments
|
|
author - String
|
The author of the project |
autosubscribeNewUsers - Boolean!
|
If true, new users will be automatically subscribed to the project page |
categories - CategoryConnection
|
|
Arguments
|
|
changeTypes - ChangeTypeConnection
|
|
Arguments
|
|
cohort - Cohort
|
|
Arguments
|
|
cohorts - CohortConnection
|
A list of all cohorts for a project |
Arguments
|
|
colorTheme - String!
|
|
connectedJiraProjects - [String!]
|
|
createdAt - ISO8601DateTime!
|
|
crmDataLastSync - ISO8601DateTime
|
Date time of when CRM data was last synced |
customCss - String
|
|
customFooter - String
|
|
customHead - String
|
|
customHeader - String
|
|
customIndexHero - String
|
|
defaultNotificationSetting - Boolean!
|
|
defaultPrompt - String!
|
|
defaultWorkItemsDisplayTimeline - Boolean!
|
|
density - String!
|
|
description - String
|
The description of the project |
editable - Boolean!
|
|
emailProjectSubscription - ProjectSubscription
|
The email project subscription for this project, specifically for your User |
emailSettings - MailAppSetting!
|
|
emailSubscription - Subscription
|
The email subscription for this project, specifically for your User |
embedApps - [EmbedApp!]!
|
|
emptyFieldImage - Image
|
The empty field image of the project, to be displayed when no announcements, work items, or ideas are published on the project page |
eventTypes - EventTypeConnection!
|
|
Arguments
|
|
events - EventConnection!
|
A list of all user triggered events on a project and its entities |
Arguments
|
|
exportFeedbacks - [Feedback!]
|
|
exportSubscribers - SubscriberConnection
|
|
Arguments
|
|
favicon - Image
|
The favicon of the project |
feedbackEnabled - Boolean!
|
Whether the feedback page is accessible on the page |
feedbackForwardEmails - [String!]!
|
When feedback is received for this project, forward it to these emails |
feedbackHappyCount - Int!
|
|
feedbackMehCount - Int!
|
|
feedbackSadCount - Int!
|
|
feedbackViaEmailEnabled - Boolean!
|
|
feedbackViaSlackEnabled - Boolean!
|
|
feedbacks - FeedbackConnection
|
|
Arguments
|
|
fiscalYearOffset - Int!
|
Number of months from when the fiscal year starts (e.g. -3 causes Q1 2024 to start October 2023, 15 causes Q1 2024 to start April 2025) |
grayColor - String!
|
|
hasPublishedIdea - Boolean!
|
|
heading - String
|
The heading of the project |
hideNotificationContent - Boolean!
|
|
id - ID!
|
|
ideas - IdeaConnection
|
A list of all ideas for a project |
Arguments
|
|
ideasDisclaimer - String
|
The disclaimer text to display on the ideas page |
ideasDisclaimerEnabled - Boolean!
|
|
ideasEnabled - Boolean!
|
Whether the ideas page is accessible on the page |
ideasName - String!
|
The name of the ideas page, will display as the title on the page |
lightGrayColor - String!
|
|
logo - Image
|
The logo of the project |
marketplaceTemplates - MarketplaceTemplateConnection!
|
|
Arguments
|
|
maxTeamMembers - Int!
|
|
name - String!
|
The name of the project |
newSubscriptionsThisMonth - Int!
|
|
noindex - Boolean!
|
|
offWhiteColor - String!
|
|
onboardingTasks - OnboardingTasks!
|
|
organization - Organization!
|
|
outboundWebhooks - [OutboundWebhook!]!
|
|
Arguments
|
|
primaryColor - String!
|
|
primaryTextColor - String!
|
|
privacyPolicyUrl - String
|
URL to use for the privacy policy link in the subscribe modal and in emails |
projectAdmins - [User!]!
|
The list of users that have an admin role in the project or organization |
projectApps - ProjectAppConnection
|
|
Arguments
|
|
projectSubscription - ProjectSubscription
|
|
projectSubscriptionByEmail - ProjectSubscription
|
|
projectSubscriptions - ProjectSubscriptionConnection
|
|
Arguments
|
|
projectUsers - UserConnection
|
A list of all users that have access to the project |
Arguments
|
|
projectView - ProjectView
|
|
Arguments
|
|
projectViews - ProjectViewConnection
|
|
Arguments
|
|
publicPageUrl - String!
|
The public page URL of the project |
publicStageDescriptionsEnabled - Boolean!
|
Whether to show or hide stage descriptions on the public roadmap |
published - Boolean!
|
Whether the project is published |
referralSource - String
|
|
restricted - Boolean!
|
|
roadmapDisclaimer - String
|
The disclaimer text to display on the roadmap page |
roadmapDisclaimerEnabled - Boolean!
|
|
roadmapEnabled - Boolean!
|
|
roadmapMoveUpdatesEnabled - Boolean!
|
|
roadmapName - String!
|
The name of the roadmap, will display as the title on the page |
roadmapWatchedStages - [String!]!
|
|
rollup - Rollup
|
|
rssFeedEnabled - Boolean
|
|
rssFeedPrivate - Boolean
|
|
rssFeedUrl - String!
|
|
rssSecretKey - String
|
|
sandbox - Boolean!
|
Whether the project is a sandbox project or not |
secondaryColor - String!
|
|
secondaryTextColor - String!
|
|
secureConnectionSettings - SecureConnectionSettings
|
|
secured - Boolean!
|
|
shareImage - Image
|
The share image of the project, will be used when sharing the project externally |
shareImageAltText - String
|
The alt text of the share image |
showToc - Boolean!
|
Show table of contents on announcement page |
slackAuthenticationUrl - String!
|
|
slackProjectSubscription - ProjectSubscription
|
The slack project subscription for this project, specifically for your User |
slackSubscription - Subscription
|
The slack subscription for this project, specifically for your User |
slackWorkspaces - [Workspace!]!
|
The workspaces connected to this project for publishing announcements |
slug - String!
|
The slug of the project, must be URL friendly, and unique |
stages - StageConnection
|
|
Arguments
|
|
subheading - String
|
The subheading of the project |
subscriberReportEnabled - Boolean!
|
|
subscribers - SubscriberConnection
|
|
Arguments
|
|
subscriptionByEmail - Subscription
|
|
Arguments
|
|
subscriptions - SubscriptionConnection
|
|
Arguments
|
|
supportingPalette - String
|
|
templates - TemplateConnection!
|
|
Arguments
|
|
termsAndConditionsUrl - String
|
URL to use for the terms and conditions link in the subscribe modal and in emails |
title - String
|
The title of the project |
totalConfirmedSubscriptions - Int!
|
|
totalUnsubscribedSubscriptions - Int!
|
|
twitterUsername - String
|
The twitter username of the project |
unreadCount - Int
|
Given an anonymous user id and a set of categories, return the number of new announcements since the last time trackOpen was called |
updatedAt - ISO8601DateTime!
|
|
vaultConnections - [String!]!
|
Array of connection IDs to the Apideck vault |
voteCountDisplay - String!
|
If true, display the vote count on published ideas |
votingEnabled - Boolean!
|
If true, allow subscribers to vote on published ideas |
whiteColor - String!
|
|
workItems - WorkItemConnection
|
|
Arguments
|
|
Example
{
"allowedDomains": ["abc123"],
"announcementDigests": AnnouncementDigestConnection,
"announcements": AnnouncementConnection,
"apiToken": ApiToken,
"apiTokens": ApiTokenConnection,
"attributeDefinitions": AttributeDefinitionConnection,
"audienceDomain": AudienceDomain,
"audienceDomains": AudienceDomainConnection,
"author": "abc123",
"autosubscribeNewUsers": true,
"categories": CategoryConnection,
"changeTypes": ChangeTypeConnection,
"cohort": Cohort,
"cohorts": CohortConnection,
"colorTheme": "abc123",
"connectedJiraProjects": ["abc123"],
"createdAt": ISO8601DateTime,
"crmDataLastSync": ISO8601DateTime,
"customCss": "abc123",
"customFooter": "xyz789",
"customHead": "abc123",
"customHeader": "abc123",
"customIndexHero": "abc123",
"defaultNotificationSetting": false,
"defaultPrompt": "abc123",
"defaultWorkItemsDisplayTimeline": false,
"density": "xyz789",
"description": "xyz789",
"editable": false,
"emailProjectSubscription": ProjectSubscription,
"emailSettings": MailAppSetting,
"emailSubscription": Subscription,
"embedApps": [EmbedApp],
"emptyFieldImage": Image,
"eventTypes": EventTypeConnection,
"events": EventConnection,
"exportFeedbacks": [Feedback],
"exportSubscribers": SubscriberConnection,
"favicon": Image,
"feedbackEnabled": false,
"feedbackForwardEmails": ["abc123"],
"feedbackHappyCount": 987,
"feedbackMehCount": 123,
"feedbackSadCount": 987,
"feedbackViaEmailEnabled": true,
"feedbackViaSlackEnabled": false,
"feedbacks": FeedbackConnection,
"fiscalYearOffset": 987,
"grayColor": "xyz789",
"hasPublishedIdea": true,
"heading": "abc123",
"hideNotificationContent": true,
"id": "4",
"ideas": IdeaConnection,
"ideasDisclaimer": "xyz789",
"ideasDisclaimerEnabled": true,
"ideasEnabled": true,
"ideasName": "abc123",
"lightGrayColor": "xyz789",
"logo": Image,
"marketplaceTemplates": MarketplaceTemplateConnection,
"maxTeamMembers": 123,
"name": "xyz789",
"newSubscriptionsThisMonth": 987,
"noindex": true,
"offWhiteColor": "abc123",
"onboardingTasks": OnboardingTasks,
"organization": Organization,
"outboundWebhooks": [OutboundWebhook],
"primaryColor": "xyz789",
"primaryTextColor": "abc123",
"privacyPolicyUrl": "xyz789",
"projectAdmins": [User],
"projectApps": ProjectAppConnection,
"projectSubscription": ProjectSubscription,
"projectSubscriptionByEmail": ProjectSubscription,
"projectSubscriptions": ProjectSubscriptionConnection,
"projectUsers": UserConnection,
"projectView": ProjectView,
"projectViews": ProjectViewConnection,
"publicPageUrl": "abc123",
"publicStageDescriptionsEnabled": true,
"published": false,
"referralSource": "abc123",
"restricted": false,
"roadmapDisclaimer": "xyz789",
"roadmapDisclaimerEnabled": false,
"roadmapEnabled": true,
"roadmapMoveUpdatesEnabled": false,
"roadmapName": "xyz789",
"roadmapWatchedStages": ["abc123"],
"rollup": Rollup,
"rssFeedEnabled": false,
"rssFeedPrivate": false,
"rssFeedUrl": "xyz789",
"rssSecretKey": "xyz789",
"sandbox": true,
"secondaryColor": "xyz789",
"secondaryTextColor": "xyz789",
"secureConnectionSettings": SecureConnectionSettings,
"secured": true,
"shareImage": Image,
"shareImageAltText": "abc123",
"showToc": true,
"slackAuthenticationUrl": "xyz789",
"slackProjectSubscription": ProjectSubscription,
"slackSubscription": Subscription,
"slackWorkspaces": [Workspace],
"slug": "abc123",
"stages": StageConnection,
"subheading": "xyz789",
"subscriberReportEnabled": false,
"subscribers": SubscriberConnection,
"subscriptionByEmail": Subscription,
"subscriptions": SubscriptionConnection,
"supportingPalette": "abc123",
"templates": TemplateConnection,
"termsAndConditionsUrl": "xyz789",
"title": "xyz789",
"totalConfirmedSubscriptions": 123,
"totalUnsubscribedSubscriptions": 987,
"twitterUsername": "xyz789",
"unreadCount": 123,
"updatedAt": ISO8601DateTime,
"vaultConnections": ["abc123"],
"voteCountDisplay": "xyz789",
"votingEnabled": true,
"whiteColor": "abc123",
"workItems": WorkItemConnection
}
ProjectApp
Types
| Union Types |
|---|
Example
HubspotApp
ProjectAppConnection
Description
The connection type for ProjectApp
Fields
| Field Name | Description |
|---|---|
edges - [ProjectAppEdge!]
|
A list of edges |
nodes - [ProjectApp]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [ProjectAppEdge],
"nodes": [HubspotApp],
"pageInfo": PageInfo,
"totalCount": 987
}
ProjectAppEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - ProjectApp
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": HubspotApp
}
ProjectConnection
Description
The connection type for Project
Fields
| Field Name | Description |
|---|---|
edges - [ProjectEdge!]
|
A list of edges |
nodes - [Project]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [ProjectEdge],
"nodes": [Project],
"pageInfo": PageInfo,
"totalCount": 123
}
ProjectEdge
ProjectRoleEnum
Values
| Enum Value | Description |
|---|---|
|
|
admin |
|
|
contribute |
|
|
feedback_agent |
|
|
publisher |
Example
"admin"
ProjectSubscription
Description
A project subscription
Fields
| Field Name | Description |
|---|---|
announcementPublished - Boolean!
|
|
categories - [Category!]!
|
Subscribed categories. An empty array means all categories are subscribed |
confirmedAt - ISO8601DateTime
|
The time the subscription was confirmed |
createdAt - ISO8601DateTime!
|
|
deactivatedAt - ISO8601DateTime
|
The time the subscription was deactivated |
eventTypes - [EventType!]!
|
|
events - EventConnection
|
|
Arguments
|
|
id - ID!
|
|
project - Project!
|
The project this subscription is for |
source - String
|
|
state - ProjectSubscriptionStateEnum!
|
The state of the subscription |
subscriber - Subscriber!
|
The subscriber of the subscription |
transportTypes - [String!]!
|
The transport types the subscription is using |
unsubscribedAt - ISO8601DateTime
|
The time the subscription was unsubscribed |
updatedAt - ISO8601DateTime!
|
|
workItems - [WorkItem!]!
|
Subscribed work items |
Example
{
"announcementPublished": true,
"categories": [Category],
"confirmedAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"deactivatedAt": ISO8601DateTime,
"eventTypes": [EventType],
"events": EventConnection,
"id": "4",
"project": Project,
"source": "abc123",
"state": "unconfirmed",
"subscriber": Subscriber,
"transportTypes": ["xyz789"],
"unsubscribedAt": ISO8601DateTime,
"updatedAt": ISO8601DateTime,
"workItems": [WorkItem]
}
ProjectSubscriptionConnection
Description
The connection type for ProjectSubscription
Fields
| Field Name | Description |
|---|---|
edges - [ProjectSubscriptionEdge!]
|
A list of edges |
nodes - [ProjectSubscription]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [ProjectSubscriptionEdge],
"nodes": [ProjectSubscription],
"pageInfo": PageInfo,
"totalCount": 123
}
ProjectSubscriptionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - ProjectSubscription
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": ProjectSubscription
}
ProjectSubscriptionInput
Description
Attributes to find, create, or update a project subscription
Example
{
"email": "xyz789",
"id": "4",
"projectId": "4"
}
ProjectSubscriptionStateEnum
Description
The states of a project subscription
Values
| Enum Value | Description |
|---|---|
|
|
The subscription has not been confirmed |
|
|
The subscription has been confirmed |
|
|
The subscription has been unsubscribed |
|
|
The subscription has been blocked |
Example
"unconfirmed"
ProjectView
Description
A shareable view for a page
Fields
| Field Name | Description |
|---|---|
archived - Boolean!
|
|
archivedAt - ISO8601DateTime
|
|
audienceDomains - AudienceDomainConnection!
|
|
Arguments
|
|
categories - [Category!]!
|
|
createdAt - ISO8601DateTime!
|
|
description - String
|
|
editable - Boolean!
|
|
heading - String
|
|
id - ID!
|
|
members - [User!]!
|
|
name - String
|
|
owners - [User!]!
|
|
privatePermalink - String!
|
|
project - Project!
|
|
publicPermalink - String!
|
|
restricted - Boolean!
|
|
security - ProjectViewSecurityEnum!
|
|
slug - String!
|
|
stages - [Stage!]!
|
|
subheading - String
|
|
subscribers - SubscriberConnection!
|
|
Arguments
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"archived": true,
"archivedAt": ISO8601DateTime,
"audienceDomains": AudienceDomainConnection,
"categories": [Category],
"createdAt": ISO8601DateTime,
"description": "abc123",
"editable": true,
"heading": "abc123",
"id": "4",
"members": [User],
"name": "xyz789",
"owners": [User],
"privatePermalink": "abc123",
"project": Project,
"publicPermalink": "xyz789",
"restricted": true,
"security": "UNPUBLISHED",
"slug": "abc123",
"stages": [Stage],
"subheading": "abc123",
"subscribers": SubscriberConnection,
"updatedAt": ISO8601DateTime
}
ProjectViewConnection
Description
The connection type for ProjectView
Fields
| Field Name | Description |
|---|---|
edges - [ProjectViewEdge!]
|
A list of edges |
nodes - [ProjectView]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [ProjectViewEdge],
"nodes": [ProjectView],
"pageInfo": PageInfo,
"totalCount": 123
}
ProjectViewEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - ProjectView
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": ProjectView
}
ProjectViewSecurityEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"UNPUBLISHED"
PromoteIdeaInput
Description
Autogenerated input type of PromoteIdea
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
ideaId - ID!
|
The ID of the idea to promote to a roadmap item |
projectId - ID!
|
The project id of the associated idea |
sendNotifications - Boolean
|
Send notifications about the promotion to all Subscribers that left feedback or voted |
Example
{
"clientMutationId": "abc123",
"ideaId": "4",
"projectId": 4,
"sendNotifications": false
}
PromoteIdeaPayload
Description
Autogenerated return type of PromoteIdea
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
workItem - WorkItem
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
PublishAnnouncementInput
Description
Autogenerated input type of PublishAnnouncement
Example
{
"clientMutationId": "xyz789",
"announcementId": "4"
}
PublishAnnouncementPayload
Description
Autogenerated return type of PublishAnnouncement
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
PublishWorkItemInput
PublishWorkItemPayload
Description
Autogenerated return type of PublishWorkItem
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
workItem - WorkItem
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
Reaction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"happy"
RemoveAllowedDomainInput
RemoveAllowedDomainPayload
Description
Autogenerated return type of RemoveAllowedDomain
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
secureConnection - SecureConnectionSettings
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"secureConnection": SecureConnectionSettings
}
RemoveAnnouncementWorkItemInput
Description
Autogenerated input type of RemoveAnnouncementWorkItem
Example
{
"clientMutationId": "xyz789",
"announcementId": "4",
"workItemId": 4
}
RemoveAnnouncementWorkItemPayload
Description
Autogenerated return type of RemoveAnnouncementWorkItem
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
RemoveApiTokenInput
RemoveApiTokenPayload
RemoveAttachmentInput
Description
Autogenerated input type of RemoveAttachment
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
id - ID!
|
|
attachment - AnnouncementAttachment!
|
Example
{
"clientMutationId": "xyz789",
"id": 4,
"attachment": "hero_image"
}
RemoveAttachmentPayload
Description
Autogenerated return type of RemoveAttachment
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
RemoveAvatarImageInput
RemoveAvatarImagePayload
Description
Autogenerated return type of RemoveAvatarImage
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
user - User
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"user": User
}
RemoveCategoryInput
RemoveCategoryPayload
Description
Autogenerated return type of RemoveCategory
Fields
| Field Name | Description |
|---|---|
category - Category
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"category": Category,
"clientMutationId": "xyz789",
"errors": [UserError]
}
RemoveChangeInput
RemoveChangePayload
Description
Autogenerated return type of RemoveChange
Fields
| Field Name | Description |
|---|---|
changeType - ChangeType
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"changeType": ChangeType,
"clientMutationId": "abc123",
"errors": [UserError]
}
RemoveEmailLogoInput
RemoveEmailLogoPayload
Description
Autogenerated return type of RemoveEmailLogo
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - String!
|
|
mailAppSetting - MailAppSetting
|
Example
{
"clientMutationId": "abc123",
"errors": "abc123",
"mailAppSetting": MailAppSetting
}
RemoveEmptyFieldImageInput
RemoveEmptyFieldImagePayload
Description
Autogenerated return type of RemoveEmptyFieldImage
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
project - Project
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"project": Project
}
RemoveFaviconInput
RemoveFaviconPayload
Description
Autogenerated return type of RemoveFavicon
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
project - Project
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"project": Project
}
RemoveFromProjectInput
RemoveFromProjectPayload
RemoveHeroImageInput
Description
Autogenerated input type of RemoveHeroImage
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
id - ID!
|
|
attachment - WorkItemHeroImage!
|
Example
{
"clientMutationId": "abc123",
"id": "4",
"attachment": "hero_image"
}
RemoveHeroImagePayload
Description
Autogenerated return type of RemoveHeroImage
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
workItem - WorkItem
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"workItem": WorkItem
}
RemoveLogoInput
RemoveLogoPayload
Description
Autogenerated return type of RemoveLogo
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
project - Project
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"project": Project
}
RemoveOwnerInput
RemoveOwnerPayload
Description
Autogenerated return type of RemoveOwner
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
workItem - WorkItem
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
RemoveProjectSubscriptionInput
Description
Autogenerated input type of RemoveProjectSubscription
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscriptionInput!
|
Input to remove a project subscription |
Example
{
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscriptionInput
}
RemoveProjectSubscriptionPayload
Description
Autogenerated return type of RemoveProjectSubscription
Example
{
"clientMutationId": "xyz789",
"projectSubscriptionId": 4
}
RemoveProjectUserInput
RemoveProjectUserPayload
Description
Autogenerated return type of RemoveProjectUser
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
project - Project
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"project": Project
}
RemoveSecureConnectionInput
Description
Autogenerated input type of RemoveSecureConnection
Example
{
"clientMutationId": "xyz789",
"projectId": 4
}
RemoveSecureConnectionPayload
Description
Autogenerated return type of RemoveSecureConnection
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError]
}
RemoveSourceInput
RemoveSourcePayload
Description
Autogenerated return type of RemoveSource
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
deletedId - ID
|
|
errors - [UserError!]!
|
Example
{
"clientMutationId": "abc123",
"deletedId": "4",
"errors": [UserError]
}
RemoveSubscriptionByEmailInput
RemoveSubscriptionByEmailPayload
Description
Autogenerated return type of RemoveSubscriptionByEmail
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [String!]!
|
|
subscription - Subscription
|
Example
{
"clientMutationId": "xyz789",
"errors": ["abc123"],
"subscription": Subscription
}
RemoveSubscriptionInput
RemoveSubscriptionPayload
Description
Autogenerated return type of RemoveSubscription
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [String!]!
|
|
subscription - Subscription
|
Example
{
"clientMutationId": "xyz789",
"errors": ["abc123"],
"subscription": Subscription
}
RemoveTemplateAttachmentInput
Description
Autogenerated input type of RemoveTemplateAttachment
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
id - ID!
|
|
attachment - TemplateAttachment!
|
Example
{
"clientMutationId": "xyz789",
"id": 4,
"attachment": "hero_image"
}
RemoveTemplateAttachmentPayload
Description
Autogenerated return type of RemoveTemplateAttachment
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
template - Template
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"template": Template
}
ReorderCategoryInput
ReorderCategoryPayload
Description
Autogenerated return type of ReorderCategory
Fields
| Field Name | Description |
|---|---|
categories - [Category!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"categories": [Category],
"clientMutationId": "xyz789",
"errors": [UserError]
}
ReorderStageAttributes
ReorderStageInput
Description
Autogenerated input type of ReorderStage
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
stage - ReorderStageAttributes!
|
Example
{
"clientMutationId": "xyz789",
"stage": ReorderStageAttributes
}
ReorderStagePayload
Description
Autogenerated return type of ReorderStage
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
stages - [Stage!]
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"stages": [Stage]
}
ReorderWorkItemAttributes
RepositionWorkItemInput
Description
Autogenerated input type of RepositionWorkItem
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
workItem - ReorderWorkItemAttributes!
|
Example
{
"clientMutationId": "abc123",
"workItem": ReorderWorkItemAttributes
}
RepositionWorkItemPayload
Description
Autogenerated return type of RepositionWorkItem
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
sourceStage - Stage
|
|
targetStage - Stage
|
|
workItem - WorkItem
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"sourceStage": Stage,
"targetStage": Stage,
"workItem": WorkItem
}
ResubscribeProjectSubscriptionInput
Description
Autogenerated input type of ResubscribeProjectSubscription
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscriptionInput!
|
Input to resubscribe a project subscription |
Example
{
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscriptionInput
}
ResubscribeProjectSubscriptionPayload
Description
Autogenerated return type of ResubscribeProjectSubscription
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscription
|
The resubscribed project subscription |
Example
{
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscription
}
ResubscribeToProjectInput
ResubscribeToProjectPayload
Description
Autogenerated return type of ResubscribeToProject
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
subscriberIds - [ID!]
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"subscriberIds": ["4"]
}
RoadmapUpdate
Fields
| Field Name | Description |
|---|---|
author - User!
|
The author of the update |
content - String!
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
title - String!
|
The headline of the |
updatedAt - ISO8601DateTime!
|
Example
{
"author": User,
"content": "xyz789",
"createdAt": ISO8601DateTime,
"id": 4,
"title": "abc123",
"updatedAt": ISO8601DateTime
}
Rollup
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
daysOfTheWeek - [String!]!
|
|
enabled - Boolean!
|
|
events - [String!]!
|
|
groupedBy - String!
|
|
id - ID!
|
|
onlyMemberItems - Boolean!
|
|
project - Project!
|
|
updatedAt - ISO8601DateTime!
|
|
user - User!
|
Example
{
"createdAt": ISO8601DateTime,
"daysOfTheWeek": ["xyz789"],
"enabled": true,
"events": ["abc123"],
"groupedBy": "abc123",
"id": 4,
"onlyMemberItems": true,
"project": Project,
"updatedAt": ISO8601DateTime,
"user": User
}
Rule
Fields
| Input Field | Description |
|---|---|
field - String!
|
|
expression - Comparator!
|
|
value - RuleValue!
|
Example
{
"field": "xyz789",
"expression": "eq",
"value": RuleValue
}
RuleValue
Description
A string, Integer, Float or Boolean
Example
RuleValue
ScheduleAnnouncementInput
Description
Autogenerated input type of ScheduleAnnouncement
Example
{
"clientMutationId": "abc123",
"announcementId": 4,
"scheduledAt": "abc123",
"scheduledAtTimezone": "xyz789"
}
ScheduleAnnouncementPayload
Description
Autogenerated return type of ScheduleAnnouncement
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
SearchResult
Types
| Union Types |
|---|
Example
Announcement
SecureConnectionSettings
Description
A project's private page settings
Fields
| Field Name | Description |
|---|---|
allowedDomains - [String!]!
|
|
autoRedirect - [Boolean!]
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"allowedDomains": ["xyz789"],
"autoRedirect": [true],
"createdAt": ISO8601DateTime,
"id": "4",
"updatedAt": ISO8601DateTime
}
SendPromoteTestInput
SendPromoteTestPayload
Description
Autogenerated return type of SendPromoteTest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]
|
|
success - Boolean!
|
The result of if the email was queued |
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"success": true
}
SendRoadmapUpdateTestEmailAttributes
Description
Attributes for sending a test email
Example
{
"title": "xyz789",
"content": "abc123",
"workItemId": 4,
"newStageId": 4
}
SendRoadmapUpdateTestEmailInput
Description
Autogenerated input type of SendRoadmapUpdateTestEmail
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
roadmapUpdate - SendRoadmapUpdateTestEmailAttributes!
|
Example
{
"clientMutationId": "xyz789",
"roadmapUpdate": SendRoadmapUpdateTestEmailAttributes
}
SendRoadmapUpdateTestEmailPayload
SimpleMailApp
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
description - String!
|
|
id - ID!
|
|
name - String!
|
|
project - Project!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"description": "abc123",
"id": "4",
"name": "xyz789",
"project": Project,
"updatedAt": ISO8601DateTime
}
SimpleMailTransport
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
subscriber - User!
|
|
type - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"subscriber": User,
"type": "xyz789",
"updatedAt": ISO8601DateTime
}
SlackApp
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
description - String!
|
|
id - ID!
|
|
name - String!
|
|
project - Project!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"description": "abc123",
"id": "4",
"name": "abc123",
"project": Project,
"updatedAt": ISO8601DateTime
}
SlackAppTransport
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
project - Project!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"project": Project,
"updatedAt": ISO8601DateTime
}
SlackCommandApp
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
description - String!
|
|
id - ID!
|
|
name - String!
|
|
project - Project!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"description": "abc123",
"id": 4,
"name": "abc123",
"project": Project,
"updatedAt": ISO8601DateTime
}
SortEnum
Values
| Enum Value | Description |
|---|---|
|
|
desc |
|
|
asc |
Example
"DESC"
Stage
Description
A stage in a roadmap
Fields
| Field Name | Description |
|---|---|
archiveAfterDays - Int
|
|
createdAt - ISO8601DateTime!
|
|
description - String
|
|
id - ID!
|
|
name - String!
|
|
position - Int!
|
|
project - Project!
|
|
published - Boolean
|
|
publishedAt - ISO8601DateTime
|
|
restricted - Boolean!
|
|
showOnPublicRoadmap - Boolean!
|
|
updatedAt - ISO8601DateTime!
|
|
workItems - WorkItemConnection
|
|
Arguments
|
|
Example
{
"archiveAfterDays": 123,
"createdAt": ISO8601DateTime,
"description": "xyz789",
"id": "4",
"name": "xyz789",
"position": 123,
"project": Project,
"published": false,
"publishedAt": ISO8601DateTime,
"restricted": true,
"showOnPublicRoadmap": true,
"updatedAt": ISO8601DateTime,
"workItems": WorkItemConnection
}
StageConnection
Description
The connection type for Stage
Fields
| Field Name | Description |
|---|---|
edges - [StageEdge!]
|
A list of edges |
nodes - [Stage]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [StageEdge],
"nodes": [Stage],
"pageInfo": PageInfo,
"totalCount": 123
}
StageEdge
String
Description
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text
Example
"abc123"
Subscribable
Fields
| Field Name | Description |
|---|---|
exportSubscribers - SubscriberConnection
|
|
Arguments
|
|
id - ID!
|
|
projectSubscription - ProjectSubscription
|
|
projectSubscriptionByEmail - ProjectSubscription
|
|
projectSubscriptions - ProjectSubscriptionConnection
|
|
Arguments
|
|
subscribers - SubscriberConnection
|
|
Arguments
|
|
subscriptions - SubscriptionConnection
|
|
Arguments
|
|
Example
{
"exportSubscribers": SubscriberConnection,
"id": "4",
"projectSubscription": ProjectSubscription,
"projectSubscriptionByEmail": ProjectSubscription,
"projectSubscriptions": ProjectSubscriptionConnection,
"subscribers": SubscriberConnection,
"subscriptions": SubscriptionConnection
}
SubscribableEnum
Values
| Enum Value | Description |
|---|---|
|
|
a project |
|
|
a work item |
Example
"PROJECT"
SubscribeProjectSubscriptionCategoryInput
Description
Autogenerated input type of SubscribeProjectSubscriptionCategory
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
categoryId - ID!
|
ID of the category to subscribe to |
projectSubscription - ProjectSubscriptionInput!
|
Input to subscribe a project subscription |
Example
{
"clientMutationId": "xyz789",
"categoryId": 4,
"projectSubscription": ProjectSubscriptionInput
}
SubscribeProjectSubscriptionCategoryPayload
Description
Autogenerated return type of SubscribeProjectSubscriptionCategory
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscription
|
The subscribed project subscription |
Example
{
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscription
}
SubscribeProjectSubscriptionWorkItemInput
Description
Autogenerated input type of SubscribeProjectSubscriptionWorkItem
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscriptionInput!
|
Input to subscribe to a work item |
workItemId - ID!
|
ID of the work item to subscribe to |
Example
{
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscriptionInput,
"workItemId": "4"
}
SubscribeProjectSubscriptionWorkItemPayload
Description
Autogenerated return type of SubscribeProjectSubscriptionWorkItem
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscription
|
The updated project subscription |
Example
{
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscription
}
SubscribedObjectAttributes
Fields
| Input Field | Description |
|---|---|
id - ID!
|
id of the object you are subscribing to |
type - SubscribableEnum!
|
type of object. Can be Project or WorkItem |
Example
{"id": "4", "type": "PROJECT"}
Subscriber
Fields
| Field Name | Description |
|---|---|
avatarColor - String!
|
Hex color code for the avatar background color |
confirmedAt - ISO8601DateTime
|
The date and time the subscriber confirmed their subscription |
createdAt - ISO8601DateTime!
|
|
email - String!
|
|
events - EventConnection!
|
|
Arguments
|
|
feedbackCount - Int!
|
Number of feedbacks submitted by the subscriber |
feedbacks - FeedbackConnection!
|
Feedback submitted by the subscriber |
Arguments
|
|
id - ID!
|
|
ideaVotes - IdeaVoteConnection!
|
Idea votes submitted by the subscriber |
Arguments
|
|
initials - String!
|
Uppercased, first character of the email |
isProjectSubscriber - Boolean!
|
|
notifications - NotificationConnection!
|
Notifications sent to the subscriber |
Arguments
|
|
updatedAt - ISO8601DateTime!
|
|
voteCount - Int!
|
Number of votes submitted by the subscriber |
workItems - WorkItemConnection!
|
Work items subscribed to by the subscriber |
Arguments
|
|
Example
{
"avatarColor": "abc123",
"confirmedAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"email": "xyz789",
"events": EventConnection,
"feedbackCount": 987,
"feedbacks": FeedbackConnection,
"id": "4",
"ideaVotes": IdeaVoteConnection,
"initials": "xyz789",
"isProjectSubscriber": false,
"notifications": NotificationConnection,
"updatedAt": ISO8601DateTime,
"voteCount": 123,
"workItems": WorkItemConnection
}
SubscriberAttributes
Fields
| Input Field | Description |
|---|---|
type - SubscriberTypes!
|
what type of subscriber. eg. USER |
id - ID
|
The ID of the subscribing user |
email - String
|
the email address you would like to subscriber |
Example
{"type": "USER", "id": 4, "email": "abc123"}
SubscriberConnection
Description
The connection type for Subscriber
Fields
| Field Name | Description |
|---|---|
edges - [SubscriberEdge!]
|
A list of edges |
nodes - [Subscriber]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [SubscriberEdge],
"nodes": [Subscriber],
"pageInfo": PageInfo,
"totalCount": 987
}
SubscriberEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
audienceDomainHostname - String!
|
|
audienceDomainId - ID!
|
|
avatarColor - String!
|
Hex color code for the avatar background color |
categories - [Category!]!
|
|
createdAt - ISO8601DateTime!
|
|
cursor - String!
|
A cursor for use in pagination |
emailTransports - [SimpleMailTransport!]!
|
|
hasMailTransport - Boolean!
|
|
hasSlackTransport - Boolean!
|
|
id - ID!
|
|
node - Subscriber!
|
The item at the end of the edge |
slackTransports - [SlackAppTransport!]!
|
|
status - SubscriptionStatus!
|
Example
{
"audienceDomainHostname": "xyz789",
"audienceDomainId": 4,
"avatarColor": "abc123",
"categories": [Category],
"createdAt": ISO8601DateTime,
"cursor": "abc123",
"emailTransports": [SimpleMailTransport],
"hasMailTransport": true,
"hasSlackTransport": false,
"id": "4",
"node": Subscriber,
"slackTransports": [SlackAppTransport],
"status": "confirmed"
}
SubscriberTypes
Values
| Enum Value | Description |
|---|---|
|
|
a user |
|
|
a subscriber |
Example
"USER"
Subscription
Description
A subscription
Fields
| Field Name | Description |
|---|---|
announcementPublished - Boolean!
|
Whether the user is subscribed to announcement.published notifications |
categories - [Category!]!
|
The categories the user is subscribed to |
createdAt - ISO8601DateTime!
|
|
eventTypes - [EventType!]!
|
|
feedbackSubmitted - Boolean!
|
Whether the user is subscribed to feedback.submitted notifications |
id - ID!
|
|
owner - SubscriptionOwner!
|
The owner of the subscription, can be a User or Subscriber |
subscribedObject - Project!
|
The project the user is subscribed to |
transport - SubscriptionTransport!
|
The transport used to send notifications to the subscriber, can be slack or email |
updatedAt - ISO8601DateTime!
|
Example
{
"announcementPublished": false,
"categories": [Category],
"createdAt": ISO8601DateTime,
"eventTypes": [EventType],
"feedbackSubmitted": false,
"id": "4",
"owner": Subscriber,
"subscribedObject": Project,
"transport": SimpleMailTransport,
"updatedAt": ISO8601DateTime
}
SubscriptionConnection
Description
The connection type for Subscription
Fields
| Field Name | Description |
|---|---|
edges - [SubscriptionEdge!]
|
A list of edges |
nodes - [Subscription]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [SubscriptionEdge],
"nodes": [Subscription],
"pageInfo": PageInfo,
"totalCount": 123
}
SubscriptionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination |
node - Subscription
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": Subscription
}
SubscriptionOwner
Types
| Union Types |
|---|
Example
Subscriber
SubscriptionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"confirmed"
SubscriptionTransport
Types
| Union Types |
|---|
Example
SimpleMailTransport
SubscriptionTypes
Values
| Enum Value | Description |
|---|---|
|
|
simple mail app |
|
|
slack app |
Example
"SimpleMailApp"
Template
Description
An announcement template
Fields
| Field Name | Description |
|---|---|
categories - [Category!]!
|
|
content - String
|
|
contentHtml - String
|
The HTML representation of the content |
contentPlainText - String
|
The plain text representation of the content |
contentType - String!
|
Defines the type of schema the content follows, draftjs to be deprecated. |
createdAt - ISO8601DateTime!
|
|
description - String
|
|
excerpt - String
|
|
excerptWithFallback - String
|
|
headline - String
|
|
heroImage - Image
|
|
id - ID!
|
|
name - String
|
|
project - Project!
|
|
updatedAt - ISO8601DateTime!
|
|
workItems - WorkItemConnection
|
|
Arguments
|
|
Example
{
"categories": [Category],
"content": "abc123",
"contentHtml": "abc123",
"contentPlainText": "abc123",
"contentType": "xyz789",
"createdAt": ISO8601DateTime,
"description": "abc123",
"excerpt": "xyz789",
"excerptWithFallback": "xyz789",
"headline": "abc123",
"heroImage": Image,
"id": "4",
"name": "abc123",
"project": Project,
"updatedAt": ISO8601DateTime,
"workItems": WorkItemConnection
}
TemplateAttachment
Values
| Enum Value | Description |
|---|---|
|
|
heroImage |
|
|
shareImage |
|
|
videoAsset |
Example
"hero_image"
TemplateConnection
Description
The connection type for Template
Fields
| Field Name | Description |
|---|---|
edges - [TemplateEdge!]
|
A list of edges |
nodes - [Template]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [TemplateEdge],
"nodes": [Template],
"pageInfo": PageInfo,
"totalCount": 123
}
TemplateEdge
ToggleEventInput
Description
Autogenerated input type of ToggleEvent
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectId - ID!
|
Owning project ID |
ownerId - ID!
|
Owing user ID |
transport - String!
|
Transport type of the subscription (SimpleMailTransport or SlackAppTransport) |
eventTypeName - String!
|
Name of the event type you would like to add or remove from the Subscription |
Example
{
"clientMutationId": "xyz789",
"projectId": 4,
"ownerId": "4",
"transport": "abc123",
"eventTypeName": "abc123"
}
ToggleEventPayload
Description
Autogenerated return type of ToggleEvent
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
subscription - Subscription
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"subscription": Subscription
}
TogglePublicStageDescriptionsInput
Description
Autogenerated input type of TogglePublicStageDescriptions
Example
{
"clientMutationId": "abc123",
"projectId": "4",
"enabled": true
}
TogglePublicStageDescriptionsPayload
TogglePublishedIdeaInput
TogglePublishedIdeaPayload
Description
Autogenerated return type of TogglePublishedIdea
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
idea - Idea
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"idea": Idea
}
ToggleSubscriberReportInput
ToggleSubscriberReportPayload
Description
Autogenerated return type of ToggleSubscriberReport
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError]
}
TrackViewedAnnouncementsInput
TrackViewedAnnouncementsPayload
Description
Autogenerated return type of TrackViewedAnnouncements
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
ok - Boolean!
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"ok": true
}
TransportEnum
Values
| Enum Value | Description |
|---|---|
|
|
Simple Mail |
|
|
Slack |
Example
"SimpleMailTransport"
TransportTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Email"
TriggerTestEmailInput
TriggerTestEmailPayload
UnarchiveAnnouncementInput
Description
Autogenerated input type of UnarchiveAnnouncement
Example
{
"clientMutationId": "abc123",
"announcementId": 4
}
UnarchiveAnnouncementPayload
Description
Autogenerated return type of UnarchiveAnnouncement
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
UnarchiveFeedbackInput
UnarchiveFeedbackPayload
Description
Autogenerated return type of UnarchiveFeedback
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
feedback - Feedback
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"feedback": Feedback
}
UnarchiveFeedbacksInput
UnarchiveFeedbacksPayload
Description
Autogenerated return type of UnarchiveFeedbacks
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
feedbacks - [Feedback!]!
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"feedbacks": [Feedback]
}
UnarchiveIdeasInput
UnarchiveIdeasPayload
Description
Autogenerated return type of UnarchiveIdeas
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
ideas - [Idea!]!
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"ideas": [Idea]
}
UnarchiveWorkItemInput
UnarchiveWorkItemPayload
Description
Autogenerated return type of UnarchiveWorkItem
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
workItem - WorkItem
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"workItem": WorkItem
}
UnpublishAnnouncementInput
Description
Autogenerated input type of UnpublishAnnouncement
Example
{
"clientMutationId": "xyz789",
"announcementId": 4
}
UnpublishAnnouncementPayload
Description
Autogenerated return type of UnpublishAnnouncement
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
UnpublishWorkItemInput
UnpublishWorkItemPayload
Description
Autogenerated return type of UnpublishWorkItem
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
workItem - WorkItem
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"workItem": WorkItem
}
UnscheduleAnnouncementInput
Description
Autogenerated input type of UnscheduleAnnouncement
Example
{
"clientMutationId": "abc123",
"announcementId": 4
}
UnscheduleAnnouncementPayload
Description
Autogenerated return type of UnscheduleAnnouncement
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "abc123",
"errors": [UserError]
}
UnsubscribeAllInput
Description
Autogenerated input type of UnsubscribeAll
Example
{
"clientMutationId": "xyz789",
"projectId": 4,
"subscriptionType": "xyz789"
}
UnsubscribeAllPayload
Description
Autogenerated return type of UnsubscribeAll
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
projectId - ID
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"projectId": 4
}
UnsubscribeFromProjectInput
UnsubscribeFromProjectPayload
Description
Autogenerated return type of UnsubscribeFromProject
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
subscriberIds - [ID!]
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"subscriberIds": ["4"]
}
UnsubscribeProjectSubscriptionAllInput
Description
Autogenerated input type of UnsubscribeProjectSubscriptionAll
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscriptionInput!
|
Input to unsubscribe a project subscription |
Example
{
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscriptionInput
}
UnsubscribeProjectSubscriptionAllPayload
Description
Autogenerated return type of UnsubscribeProjectSubscriptionAll
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscription
|
The unsubscribed project subscription |
Example
{
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscription
}
UnsubscribeProjectSubscriptionCategoryInput
Description
Autogenerated input type of UnsubscribeProjectSubscriptionCategory
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
categoryId - ID!
|
ID of the category to unsubscribe from |
projectSubscription - ProjectSubscriptionInput!
|
Input to unsubscribe a project subscription |
Example
{
"clientMutationId": "xyz789",
"categoryId": "4",
"projectSubscription": ProjectSubscriptionInput
}
UnsubscribeProjectSubscriptionCategoryPayload
Description
Autogenerated return type of UnsubscribeProjectSubscriptionCategory
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscription
|
The unsubscribed project subscription |
Example
{
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscription
}
UnsubscribeProjectSubscriptionInput
Description
Autogenerated input type of UnsubscribeProjectSubscription
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscriptionInput!
|
Input to unsubscribe a project subscription |
Example
{
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscriptionInput
}
UnsubscribeProjectSubscriptionPayload
Description
Autogenerated return type of UnsubscribeProjectSubscription
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscription
|
The unsubscribed project subscription |
Example
{
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscription
}
UnsubscribeProjectSubscriptionWorkItemInput
Description
Autogenerated input type of UnsubscribeProjectSubscriptionWorkItem
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscriptionInput!
|
Input to subscribe to a work item |
workItemId - ID!
|
ID of the work item to subscribe to |
Example
{
"clientMutationId": "abc123",
"projectSubscription": ProjectSubscriptionInput,
"workItemId": 4
}
UnsubscribeProjectSubscriptionWorkItemPayload
Description
Autogenerated return type of UnsubscribeProjectSubscriptionWorkItem
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscription
|
The unsubscribed project subscription |
Example
{
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscription
}
UpdateAnnouncementAttributes
Description
Attributes for updating a announcement
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the announcement you would like to update |
headline - String
|
|
content - String
|
|
excerpt - String
|
|
title - String
|
|
slug - String
|
|
description - String
|
|
author - String
|
|
doNotIndex - Boolean
|
|
heroImage - String
|
|
shareImage - String
|
|
shouldNotifyPageSubscribers - Boolean
|
|
notificationsExcerptOnly - Boolean
|
|
subjectLine - String
|
|
slackMessage - String
|
|
categories - [CategoryAttributes!]
|
Associated categories of the announcement |
workItems - [WorkItemAttributes!]
|
Associated work items of the announcement |
changeTypeIds - [ID!]
|
Associated change types of the announcement. Change types are called Labels in the management portal |
publishedAt - String
|
|
confluenceSpaceId - String
|
|
labels - [String!]
|
|
videoAsset - VideoAssetAttributes
|
Associated video asset of the announcement |
Example
{
"id": 4,
"headline": "xyz789",
"content": "xyz789",
"excerpt": "xyz789",
"title": "abc123",
"slug": "abc123",
"description": "xyz789",
"author": "xyz789",
"doNotIndex": true,
"heroImage": "xyz789",
"shareImage": "abc123",
"shouldNotifyPageSubscribers": false,
"notificationsExcerptOnly": true,
"subjectLine": "abc123",
"slackMessage": "xyz789",
"categories": [CategoryAttributes],
"workItems": [WorkItemAttributes],
"changeTypeIds": [4],
"publishedAt": "xyz789",
"confluenceSpaceId": "xyz789",
"labels": ["xyz789"],
"videoAsset": VideoAssetAttributes
}
UpdateAnnouncementInput
Description
Autogenerated input type of UpdateAnnouncement
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
announcement - UpdateAnnouncementAttributes!
|
Example
{
"clientMutationId": "xyz789",
"announcement": UpdateAnnouncementAttributes
}
UpdateAnnouncementPayload
Description
Autogenerated return type of UpdateAnnouncement
Fields
| Field Name | Description |
|---|---|
announcement - Announcement
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"announcement": Announcement,
"clientMutationId": "xyz789",
"errors": [UserError]
}
UpdateAttributeInput
Description
Autogenerated input type of UpdateAttribute
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
key - String!
|
|
id - ID!
|
|
value - AttributeValue
|
Example
{
"clientMutationId": "xyz789",
"key": "abc123",
"id": "4",
"value": AttributeValue
}
UpdateAttributePayload
Description
Autogenerated return type of UpdateAttribute
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
node - HasAttributes
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"node": HasAttributes
}
UpdateAttributes
Description
Attributes for updating a subscription
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
eventTypes - [EventTypeAttributes!]
|
Event types you would like receive notifications on |
categories - [CategoryAttributes!]
|
Associated categories of the announcement |
Example
{
"id": "4",
"eventTypes": [EventTypeAttributes],
"categories": [CategoryAttributes]
}
UpdateByEmailAttributes
Description
Attributes for updating a subscription
Fields
| Input Field | Description |
|---|---|
email - String!
|
The subscriber email you would like to update. Must also include the subscription type |
projectId - ID!
|
If looking up by email, you must provide the project id |
eventTypes - [EventTypeAttributes!]
|
Event types you would like receive notifications on |
categories - [CategoryAttributes!]
|
Associated categories of the announcement |
Example
{
"email": "abc123",
"projectId": 4,
"eventTypes": [EventTypeAttributes],
"categories": [CategoryAttributes]
}
UpdateCategoryInput
Description
Autogenerated input type of UpdateCategory
Example
{
"clientMutationId": "abc123",
"id": 4,
"name": "xyz789",
"slug": "xyz789",
"description": "abc123",
"position": 987,
"color": "abc123"
}
UpdateCategoryPayload
Description
Autogenerated return type of UpdateCategory
Fields
| Field Name | Description |
|---|---|
category - Category
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"category": Category,
"clientMutationId": "abc123",
"errors": [UserError]
}
UpdateChangeInput
UpdateChangePayload
Description
Autogenerated return type of UpdateChange
Fields
| Field Name | Description |
|---|---|
changeType - ChangeType
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
Example
{
"changeType": ChangeType,
"clientMutationId": "abc123",
"errors": [UserError]
}
UpdateExternalContentLinkInput
Description
Autogenerated input type of UpdateExternalContentLink
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
externalContentLink - UpdateLinkAttributes!
|
Example
{
"clientMutationId": "abc123",
"externalContentLink": UpdateLinkAttributes
}
UpdateExternalContentLinkPayload
Description
Autogenerated return type of UpdateExternalContentLink
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
stage - Stage
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"stage": Stage
}
UpdateFeedbackAttributes
Example
{
"id": 4,
"starred": true,
"content": "xyz789",
"notes": "abc123",
"reaction": "abc123",
"importance": "abc123",
"affectedCustomerEmail": "abc123",
"feedbackableId": "4",
"feedbackableType": "abc123"
}
UpdateFeedbackInput
Description
Autogenerated input type of UpdateFeedback
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
feedback - UpdateFeedbackAttributes!
|
Example
{
"clientMutationId": "abc123",
"feedback": UpdateFeedbackAttributes
}
UpdateFeedbackPayload
Description
Autogenerated return type of UpdateFeedback
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
feedback - Feedback
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"feedback": Feedback
}
UpdateIdeaInput
Description
Autogenerated input type of UpdateIdea
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
id - ID!
|
The ID of the idea you would like to update |
name - String
|
|
notes - String
|
|
categories - [CategoryAttributes!]
|
Associated categories of the idea |
Example
{
"clientMutationId": "abc123",
"id": 4,
"name": "abc123",
"notes": "xyz789",
"categories": [CategoryAttributes]
}
UpdateIdeaPayload
Description
Autogenerated return type of UpdateIdea
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
idea - Idea
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"idea": Idea
}
UpdateLinkAttributes
UpdateMailAppSettingsAttributes
Description
Attributes for updating a MailAppSetting
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the settings object you would like to update |
logo - String
|
The logo that will be used in your email templates |
primaryColor - String
|
The accent color that will be used in your email templates |
logoHeight - String
|
Height of the logo images in pixels |
headingColor - String
|
Hex color for heading text |
superscriptColor - String
|
Hex color for superscript text |
textColor - String
|
Hex color for body text |
digestTextColor - String
|
Hex color for digest text |
digestBackgroundColor - String
|
Hex color for digest background |
bodyBackgroundColor - String
|
Hex color for body background color |
containerBackgroundColor - String
|
Hex color for content text |
fontFamily - String
|
Comma seperated list of font families to be inserted into emails |
categoriesEnabled - Boolean
|
When set to true, associated categories will be included in emails |
announcementButtonCta - String
|
CTA Button text for announcement published emails |
subscriberConfirmButtonCta - String
|
CTA Button text for subscriber confirmation emails |
senderName - String
|
Sender name on email notifications |
replyToEmail - String
|
Email address on email notifications |
activeEsp - String
|
Email Service Provider that will be delivering your notifications. Currently supported: Mailgun, Postmark, Sendgrid, SMTP |
apiKey - String
|
API Key for your ESP |
domain - String
|
Domain for your ESP |
euDomain - Boolean
|
When set to true, the EU domain will be used for email notifications |
smtpUser - String
|
SMTP Username for email notifications |
smtpPassword - String
|
SMTP Password for email notifications |
smtpHost - String
|
SMTP Host for email notifications |
smtpSecure - Boolean
|
SMTP sent securely |
smtpPort - String
|
SMTP Port for email notifications |
notificationsExcerptOnly - Boolean
|
When set to true, only include the announcement excerpt in the notification email |
Example
{
"id": 4,
"logo": "abc123",
"primaryColor": "xyz789",
"logoHeight": "abc123",
"headingColor": "abc123",
"superscriptColor": "abc123",
"textColor": "abc123",
"digestTextColor": "abc123",
"digestBackgroundColor": "abc123",
"bodyBackgroundColor": "abc123",
"containerBackgroundColor": "xyz789",
"fontFamily": "xyz789",
"categoriesEnabled": false,
"announcementButtonCta": "abc123",
"subscriberConfirmButtonCta": "xyz789",
"senderName": "xyz789",
"replyToEmail": "abc123",
"activeEsp": "abc123",
"apiKey": "abc123",
"domain": "abc123",
"euDomain": false,
"smtpUser": "abc123",
"smtpPassword": "abc123",
"smtpHost": "xyz789",
"smtpSecure": false,
"smtpPort": "abc123",
"notificationsExcerptOnly": true
}
UpdateMailAppSettingsInput
Description
Autogenerated input type of UpdateMailAppSettings
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
mailAppSetting - UpdateMailAppSettingsAttributes!
|
Example
{
"clientMutationId": "abc123",
"mailAppSetting": UpdateMailAppSettingsAttributes
}
UpdateMailAppSettingsPayload
Description
Autogenerated return type of UpdateMailAppSettings
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
mailAppSetting - MailAppSetting
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"mailAppSetting": MailAppSetting
}
UpdateOnboardingTasksAttributes
Fields
| Input Field | Description |
|---|---|
addAnnouncement - Boolean
|
|
addSubscriber - Boolean
|
|
addUser - Boolean
|
|
addWorkItem - Boolean
|
|
claimSubdomain - Boolean
|
|
customizeCategories - Boolean
|
|
customizeColors - Boolean
|
|
customizeEmail - Boolean
|
|
customizeHtmlCss - Boolean
|
|
customizeRoadmapStages - Boolean
|
|
enableRoadmap - Boolean
|
|
uploadLogo - Boolean
|
Example
{
"addAnnouncement": false,
"addSubscriber": false,
"addUser": false,
"addWorkItem": false,
"claimSubdomain": true,
"customizeCategories": false,
"customizeColors": true,
"customizeEmail": true,
"customizeHtmlCss": true,
"customizeRoadmapStages": true,
"enableRoadmap": true,
"uploadLogo": true
}
UpdateOnboardingTasksInput
Description
Autogenerated input type of UpdateOnboardingTasks
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectId - ID!
|
The ID of the project you would like to update |
onboardingTasks - UpdateOnboardingTasksAttributes!
|
Example
{
"clientMutationId": "abc123",
"projectId": 4,
"onboardingTasks": UpdateOnboardingTasksAttributes
}
UpdateOnboardingTasksPayload
Description
Autogenerated return type of UpdateOnboardingTasks
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
onboardingTasks - OnboardingTasks!
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"onboardingTasks": OnboardingTasks
}
UpdateProjectAttributes
Description
Attributes for updating a project
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the project you would like to update |
name - String
|
|
published - Boolean
|
|
slug - String
|
|
heading - String
|
|
subheading - String
|
|
title - String
|
|
description - String
|
|
author - String
|
|
showToc - Boolean
|
|
shareImage - String
|
|
shareImageAltText - String
|
|
twitterUsername - String
|
|
logo - String
|
|
emptyFieldImage - String
|
|
favicon - String
|
|
primaryColor - String
|
|
supportingPalette - String
|
|
secondaryColor - String
|
|
whiteColor - String
|
|
offWhiteColor - String
|
|
grayColor - String
|
|
lightGrayColor - String
|
|
primaryTextColor - String
|
|
secondaryTextColor - String
|
|
colorTheme - String
|
|
density - String
|
|
noindex - Boolean
|
|
customCss - String
|
|
customHead - String
|
|
customHeader - String
|
|
customFooter - String
|
|
customIndexHero - String
|
|
privacyPolicyUrl - String
|
|
termsAndConditionsUrl - String
|
|
fiscalYearOffset - Int
|
|
hideNotificationContent - Boolean
|
|
defaultNotificationSetting - Boolean
|
|
autosubscribeNewUsers - Boolean
|
|
roadmapName - String
|
|
roadmapEnabled - Boolean
|
|
roadmapDisclaimer - String
|
|
roadmapDisclaimerEnabled - Boolean
|
|
ideasDisclaimer - String
|
|
ideasDisclaimerEnabled - Boolean
|
|
feedbackEnabled - Boolean
|
|
feedbackForwardEmails - [String!]
|
|
ideasEnabled - Boolean
|
|
ideasName - String
|
|
votingEnabled - Boolean
|
|
voteCountDisplay - String
|
|
referralSource - String
|
|
allowedDomains - [String!]
|
|
crmStageFilters - [String!]
|
Stage ids to include in crm revenue data |
rssFeedEnabled - Boolean
|
|
rssFeedPrivate - Boolean
|
|
defaultWorkItemsDisplayTimeline - Boolean
|
|
roadmapMoveUpdatesEnabled - Boolean
|
|
roadmapWatchedStages - [String!]
|
|
stageIds - [String!]
|
|
restricted - Boolean
|
Example
{
"id": 4,
"name": "abc123",
"published": false,
"slug": "xyz789",
"heading": "abc123",
"subheading": "abc123",
"title": "abc123",
"description": "abc123",
"author": "xyz789",
"showToc": false,
"shareImage": "abc123",
"shareImageAltText": "xyz789",
"twitterUsername": "abc123",
"logo": "xyz789",
"emptyFieldImage": "xyz789",
"favicon": "abc123",
"primaryColor": "abc123",
"supportingPalette": "xyz789",
"secondaryColor": "abc123",
"whiteColor": "xyz789",
"offWhiteColor": "abc123",
"grayColor": "abc123",
"lightGrayColor": "xyz789",
"primaryTextColor": "xyz789",
"secondaryTextColor": "xyz789",
"colorTheme": "abc123",
"density": "xyz789",
"noindex": false,
"customCss": "abc123",
"customHead": "xyz789",
"customHeader": "abc123",
"customFooter": "xyz789",
"customIndexHero": "xyz789",
"privacyPolicyUrl": "xyz789",
"termsAndConditionsUrl": "abc123",
"fiscalYearOffset": 123,
"hideNotificationContent": true,
"defaultNotificationSetting": true,
"autosubscribeNewUsers": true,
"roadmapName": "xyz789",
"roadmapEnabled": true,
"roadmapDisclaimer": "abc123",
"roadmapDisclaimerEnabled": false,
"ideasDisclaimer": "abc123",
"ideasDisclaimerEnabled": false,
"feedbackEnabled": true,
"feedbackForwardEmails": ["xyz789"],
"ideasEnabled": false,
"ideasName": "abc123",
"votingEnabled": true,
"voteCountDisplay": "abc123",
"referralSource": "abc123",
"allowedDomains": ["xyz789"],
"crmStageFilters": ["xyz789"],
"rssFeedEnabled": false,
"rssFeedPrivate": false,
"defaultWorkItemsDisplayTimeline": false,
"roadmapMoveUpdatesEnabled": true,
"roadmapWatchedStages": ["abc123"],
"stageIds": ["abc123"],
"restricted": true
}
UpdateProjectInput
Description
Autogenerated input type of UpdateProject
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
project - UpdateProjectAttributes!
|
Example
{
"clientMutationId": "abc123",
"project": UpdateProjectAttributes
}
UpdateProjectPayload
Description
Autogenerated return type of UpdateProject
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
project - Project
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"project": Project
}
UpdateProjectUserRoleInput
Description
Autogenerated input type of UpdateProjectUserRole
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
userId - ID!
|
The user's id to update |
projectId - ID!
|
The project id that the role belongs to |
role - ProjectRoleEnum!
|
The new role for the user |
Example
{
"clientMutationId": "abc123",
"userId": 4,
"projectId": 4,
"role": "admin"
}
UpdateProjectUserRolePayload
Description
Autogenerated return type of UpdateProjectUserRole
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
projectUser - User
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"projectUser": User
}
UpdateSecureConnectionInput
Description
Autogenerated input type of UpdateSecureConnection
Example
{
"clientMutationId": "abc123",
"id": 4,
"allowedDomain": "abc123",
"autoRedirect": true
}
UpdateSecureConnectionPayload
Description
Autogenerated return type of UpdateSecureConnection
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
secureConnection - SecureConnectionSettings
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"secureConnection": SecureConnectionSettings
}
UpdateStageAttributes
UpdateStageInput
Description
Autogenerated input type of UpdateStage
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
stage - UpdateStageAttributes!
|
Example
{
"clientMutationId": "xyz789",
"stage": UpdateStageAttributes
}
UpdateStagePayload
Description
Autogenerated return type of UpdateStage
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
stage - Stage
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"stage": Stage
}
UpdateSubscriptionByEmailInput
Description
Autogenerated input type of UpdateSubscriptionByEmail
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
attributes - UpdateByEmailAttributes!
|
Example
{
"clientMutationId": "abc123",
"attributes": UpdateByEmailAttributes
}
UpdateSubscriptionByEmailPayload
Description
Autogenerated return type of UpdateSubscriptionByEmail
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
subscription - ProjectSubscription
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"subscription": ProjectSubscription
}
UpdateSubscriptionInput
Description
Autogenerated input type of UpdateSubscription
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
attributes - UpdateAttributes!
|
Example
{
"clientMutationId": "xyz789",
"attributes": UpdateAttributes
}
UpdateSubscriptionPayload
Description
Autogenerated return type of UpdateSubscription
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
subscription - Subscription
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"subscription": Subscription
}
UpdateTemplateAttributes
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
description - String
|
|
headline - String
|
|
content - String
|
|
excerpt - String
|
|
heroImage - String
|
|
categories - [CategoryAttributes!]
|
|
workItems - [WorkItemAttributes!]
|
Example
{
"id": "4",
"name": "abc123",
"description": "abc123",
"headline": "abc123",
"content": "xyz789",
"excerpt": "abc123",
"heroImage": "abc123",
"categories": [CategoryAttributes],
"workItems": [WorkItemAttributes]
}
UpdateTemplateInput
Description
Autogenerated input type of UpdateTemplate
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
template - UpdateTemplateAttributes!
|
Example
{
"clientMutationId": "abc123",
"template": UpdateTemplateAttributes
}
UpdateTemplatePayload
Description
Autogenerated return type of UpdateTemplate
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
template - Template
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"template": Template
}
UpdateUserAttributes
Description
Attributes for updating a user
Example
{
"id": 4,
"firstName": "abc123",
"lastName": "xyz789",
"defaultProjectId": 4,
"avatarImage": "xyz789"
}
UpdateUserInput
Description
Autogenerated input type of UpdateUser
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
user - UpdateUserAttributes!
|
Example
{
"clientMutationId": "xyz789",
"user": UpdateUserAttributes
}
UpdateUserPayload
Description
Autogenerated return type of UpdateUser
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
user - User
|
Example
{
"clientMutationId": "xyz789",
"errors": [UserError],
"user": User
}
UpdateWorkItemAttributes
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the work_item you would like to update |
name - String
|
|
content - String
|
|
contentJira - String
|
Jira Wiki Syntax |
contentHtml - String
|
HTML Content to be converted |
contentMarkdown - String
|
Markdown content to be converted |
projectedAt - String
|
Projected at timestamp; pass in null to unset the date. Default = "" |
projectedAtFormat - String
|
|
categories - [CategoryAttributes!]
|
Associated categories of the announcement |
changeTypeIds - [String!]
|
Associated change types of the work item. Change types are called Labels in the management portal |
heroImage - String
|
|
displayTimeline - Boolean
|
Publicly display timeline for the work item |
ownerId - ID
|
The ID of the user who owns the work item |
memberIds - [ID!]
|
The IDs of the users who are members of the work item |
Example
{
"id": "4",
"name": "abc123",
"content": "xyz789",
"contentJira": "abc123",
"contentHtml": "abc123",
"contentMarkdown": "abc123",
"projectedAt": "abc123",
"projectedAtFormat": "xyz789",
"categories": [CategoryAttributes],
"changeTypeIds": ["xyz789"],
"heroImage": "abc123",
"displayTimeline": false,
"ownerId": 4,
"memberIds": [4]
}
UpdateWorkItemInput
Description
Autogenerated input type of UpdateWorkItem
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
workItem - UpdateWorkItemAttributes!
|
Example
{
"clientMutationId": "abc123",
"workItem": UpdateWorkItemAttributes
}
UpdateWorkItemPayload
Description
Autogenerated return type of UpdateWorkItem
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
errors - [UserError!]!
|
|
workItem - WorkItem
|
Example
{
"clientMutationId": "abc123",
"errors": [UserError],
"workItem": WorkItem
}
User
Fields
| Field Name | Description |
|---|---|
avatarColor - String!
|
Get the user's avatar color |
avatarImage - Image
|
Get the user's avatar image |
confirmedAt - ISO8601DateTime
|
|
createdAt - ISO8601DateTime!
|
|
defaultProject - Project
|
Get the users default project |
displayName - String!
|
Get the user's display name; becomes email if first and last name is not set |
email - String!
|
The user's email address |
firstName - String
|
Get the user's first name |
greatestPermission - String!
|
Use the permissions field instead
|
Arguments
|
|
id - ID!
|
|
initials - String!
|
Get the user's initials; becomes first letter of email if first name is not set |
lastName - String
|
Get the user's last name |
name - String
|
The user's full name (first and last) |
organization - Organization
|
Get user's organization by ID |
Arguments
|
|
organizations - [Organization!]!
|
Get listing of organizations the user is associated to, (by ID) |
permissions - [String!]!
|
Get a list of the user's roles |
Arguments
|
|
project - Project!
|
Retrieve a project by ID |
Arguments
|
|
projects - ProjectConnection!
|
|
Arguments
|
|
referralSource - UserReferralSourceEnum!
|
The user's referral source, collected during onboarding |
role - UserRoleEnum!
|
The user's role, defined on signup. This could be one of the following: customerSuccess, customerSupport, engineering, executive, marketing, product, or all |
status - String!
|
|
subscriptions - [Subscription!]!
|
Get listing of user's subscription types to an organization |
Arguments
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"avatarColor": "xyz789",
"avatarImage": Image,
"confirmedAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"defaultProject": Project,
"displayName": "xyz789",
"email": "xyz789",
"firstName": "abc123",
"greatestPermission": "xyz789",
"id": "4",
"initials": "xyz789",
"lastName": "xyz789",
"name": "xyz789",
"organization": Organization,
"organizations": [Organization],
"permissions": ["abc123"],
"project": Project,
"projects": ProjectConnection,
"referralSource": "search_engine",
"role": "all",
"status": "xyz789",
"subscriptions": [Subscription],
"updatedAt": ISO8601DateTime
}
UserConnection
Description
The connection type for User
Fields
| Field Name | Description |
|---|---|
edges - [UserEdge!]
|
A list of edges |
nodes - [User]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [UserEdge],
"nodes": [User],
"pageInfo": PageInfo,
"totalCount": 987
}
UserEdge
UserError
UserReferralSourceEnum
Values
| Enum Value | Description |
|---|---|
|
|
Search engine |
|
|
Recommended by a friend or community |
|
|
A blog or publication |
|
|
Powered By link |
|
|
Other |
Example
"search_engine"
UserRoleEnum
Values
| Enum Value | Description |
|---|---|
|
|
All of the above |
|
|
Customer success |
|
|
Customer support |
|
|
Engineering |
|
|
Executive |
|
|
Marketing |
|
|
Product |
Example
"all"
Value
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"string"
VideoAsset
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
embedType - String!
|
the embedable video type |
heightRatio - String
|
The video height ratio |
id - ID!
|
|
thumbnailUrl - String
|
The video thumbnail or gif |
updatedAt - ISO8601DateTime!
|
|
videoUrl - String!
|
The video url to embed |
Example
{
"createdAt": ISO8601DateTime,
"embedType": "abc123",
"heightRatio": "xyz789",
"id": 4,
"thumbnailUrl": "abc123",
"updatedAt": ISO8601DateTime,
"videoUrl": "xyz789"
}
VideoAssetAttributes
Example
{
"embedType": "xyz789",
"videoUrl": "xyz789",
"thumbnailUrl": "abc123",
"heightRatio": "xyz789"
}
ViewerAnalyticsObject
Fields
| Field Name | Description |
|---|---|
totalUniqueAnonymousCount - Int!
|
|
totalUniqueEmbeddedCount - Int!
|
|
totalUniqueSubscribersCount - Int!
|
|
uniqueVisitors - [ViewerChartData!]!
|
Example
{
"totalUniqueAnonymousCount": 987,
"totalUniqueEmbeddedCount": 123,
"totalUniqueSubscribersCount": 987,
"uniqueVisitors": [ViewerChartData]
}
ViewerChartData
Fields
| Field Name | Description |
|---|---|
date - ISO8601DateTime!
|
|
uniqueAnonymousVisitors - Int
|
|
uniqueEmbeddedVisitors - Int
|
|
uniqueSubscribedVisitors - Int
|
Example
{
"date": ISO8601DateTime,
"uniqueAnonymousVisitors": 987,
"uniqueEmbeddedVisitors": 123,
"uniqueSubscribedVisitors": 123
}
Vote
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
idea - Idea!
|
|
subscriber - Subscriber!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"idea": Idea,
"subscriber": Subscriber,
"updatedAt": ISO8601DateTime
}
VoteConnection
Description
The connection type for Vote
Fields
| Field Name | Description |
|---|---|
edges - [VoteEdge!]
|
A list of edges |
nodes - [Vote]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [VoteEdge],
"nodes": [Vote],
"pageInfo": PageInfo,
"totalCount": 123
}
VoteEdge
WebhookOwner
Description
The Project or Organization that owns the webhook
Types
| Union Types |
|---|
Example
Organization
Where
WorkItem
Fields
| Field Name | Description |
|---|---|
announcements - AnnouncementConnection
|
Announcements associated with the work item |
Arguments
|
|
archived - Boolean!
|
|
categories - [Category!]!
|
The categories the work item is associated with |
changeTypes - ChangeTypeConnection!
|
The change types the work item is associated with. Change types are called Labels in the management portal |
Arguments
|
|
connectedSources - ConnectedSourceConnection
|
Connected external data sources. Internal use only |
Arguments
|
|
content - String
|
|
contentHtml - String
|
The HTML representation of the content |
contentPlainText - String
|
The plain text representation of the content |
contentType - String!
|
Defines the type of schema the content follows, draftjs to be deprecated. |
createdAt - ISO8601DateTime!
|
|
deactivatedAt - ISO8601DateTime
|
|
displayTimeline - Boolean!
|
Whether the timeline is displayed on the work item |
events - EventConnection
|
|
Arguments
|
|
excerptWithFallback - String
|
The excerpt of the work item, falls back to the name if no excerpt is present |
exportFeedbacks - [Feedback!]
|
|
exportSubscribers - SubscriberConnection
|
|
Arguments
|
|
externalContentLinks - [ExternalContentLink!]
|
External content links associated with the work item |
feedbackHappyCount - Int!
|
|
feedbackMehCount - Int!
|
|
feedbackSadCount - Int!
|
|
feedbacks - FeedbackConnection
|
|
Arguments
|
|
heroImage - Image
|
The hero image of the work item |
id - ID!
|
|
ideas - [Idea!]!
|
The ideas associated with the work item |
members - [User!]!
|
The users assigned to the work item |
name - String!
|
The name of the work item |
owner - User
|
The owning user of the work item |
position - Int!
|
The position of the work item within a stage |
privatePermalink - String!
|
|
projectSubscription - ProjectSubscription
|
|
projectSubscriptionByEmail - ProjectSubscription
|
|
projectSubscriptions - ProjectSubscriptionConnection
|
|
Arguments
|
|
projectedAt - String
|
The projected date of release for the work item |
projectedAtFormat - String!
|
The format of the projected_at date, can be "exact", "fuzzy", "super-fuzzy" or "none" |
publicPermalink - String!
|
|
publishedAt - ISO8601DateTime
|
|
roadmapUpdates - [RoadmapUpdate!]!
|
|
showOnPublicRoadmap - Boolean!
|
Whether the work item is shown on the public roadmap |
slug - String!
|
The slug of the work item, must be URL safe and unique within the project |
stage - Stage
|
The stage the work item is displayed under |
stageId - ID!
|
|
state - WorkItemStateEnum!
|
|
subscribers - SubscriberConnection
|
|
Arguments
|
|
subscriptions - SubscriptionConnection
|
|
Arguments
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"announcements": AnnouncementConnection,
"archived": false,
"categories": [Category],
"changeTypes": ChangeTypeConnection,
"connectedSources": ConnectedSourceConnection,
"content": "abc123",
"contentHtml": "xyz789",
"contentPlainText": "xyz789",
"contentType": "abc123",
"createdAt": ISO8601DateTime,
"deactivatedAt": ISO8601DateTime,
"displayTimeline": true,
"events": EventConnection,
"excerptWithFallback": "abc123",
"exportFeedbacks": [Feedback],
"exportSubscribers": SubscriberConnection,
"externalContentLinks": [ExternalContentLink],
"feedbackHappyCount": 987,
"feedbackMehCount": 987,
"feedbackSadCount": 123,
"feedbacks": FeedbackConnection,
"heroImage": Image,
"id": 4,
"ideas": [Idea],
"members": [User],
"name": "xyz789",
"owner": User,
"position": 123,
"privatePermalink": "abc123",
"projectSubscription": ProjectSubscription,
"projectSubscriptionByEmail": ProjectSubscription,
"projectSubscriptions": ProjectSubscriptionConnection,
"projectedAt": "abc123",
"projectedAtFormat": "xyz789",
"publicPermalink": "abc123",
"publishedAt": ISO8601DateTime,
"roadmapUpdates": [RoadmapUpdate],
"showOnPublicRoadmap": true,
"slug": "abc123",
"stage": Stage,
"stageId": "4",
"state": "draft",
"subscribers": SubscriberConnection,
"subscriptions": SubscriptionConnection,
"updatedAt": ISO8601DateTime
}
WorkItemAttributes
WorkItemConnection
Description
The connection type for WorkItem
Fields
| Field Name | Description |
|---|---|
edges - [WorkItemEdge!]
|
A list of edges |
nodes - [WorkItem]
|
A list of nodes |
pageInfo - PageInfo!
|
Information to aid in pagination |
totalCount - Int!
|
Example
{
"edges": [WorkItemEdge],
"nodes": [WorkItem],
"pageInfo": PageInfo,
"totalCount": 123
}
WorkItemEdge
WorkItemHeroImage
Values
| Enum Value | Description |
|---|---|
|
|
heroImage |
Example
"hero_image"
WorkItemStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
Draft |
|
|
Published |
|
|
Archived |
Example
"draft"
Workspace
Fields
| Field Name | Description |
|---|---|
channels - [Channel!]
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
installed - Boolean!
|
|
name - String!
|
|
project - Project!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"channels": [Channel],
"createdAt": ISO8601DateTime,
"id": 4,
"installed": false,
"name": "abc123",
"project": Project,
"updatedAt": ISO8601DateTime
}
ZapierApp
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
description - String!
|
|
id - ID!
|
|
name - String!
|
|
project - Project!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"description": "abc123",
"id": 4,
"name": "abc123",
"project": Project,
"updatedAt": ISO8601DateTime
}
updateProjectSubscriptionInput
Description
Autogenerated input type of updateProjectSubscription
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
categoryIds - [ID!]
|
Array of category IDs to subscribe to. Pass in an empty array to subscribe to all categories. Default = null |
projectSubscription - ProjectSubscriptionInput!
|
Input to update a project subscription |
workItemIds - [ID!]
|
Array of work item IDs to subscribe to. Pass in an empty array to unsubscribe to all work items. Default = null |
Example
{
"clientMutationId": "abc123",
"categoryIds": [4],
"projectSubscription": ProjectSubscriptionInput,
"workItemIds": ["4"]
}
updateProjectSubscriptionPayload
Description
Autogenerated return type of updateProjectSubscription
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation |
projectSubscription - ProjectSubscription
|
The updated project subscription |
Example
{
"clientMutationId": "xyz789",
"projectSubscription": ProjectSubscription
}