Mutation
mutation UpdateHelpCenterIndex($input: UpdateHelpCenterIndexInput!) {
updateHelpCenterIndex(input: $input) {
helpCenterIndex {
helpCenterId
hash
navIndex {
type
id
title
slug
parentId
status
}
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
__typename
}
}
updatedAt {
unixTimestamp
iso8601
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"helpCenterId": "id",
"hash": "string",
"helpCenterIndex": [
{
"type": "ARTICLE",
"entityId": "id"
}
]
}
}Response
{
"data": {
"updateHelpCenterIndex": {
"helpCenterIndex": {
"helpCenterId": "id",
"hash": "string",
"navIndex": [
{
"type": "ARTICLE",
"id": "id",
"title": "string",
"slug": "string",
"parentId": "id",
"status": "PUBLISHED"
}
],
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor"
},
"updatedAt": {
"unixTimestamp": "string",
"iso8601": "string"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
updateHelpCenterIndex
Replace the navigation index (sidebar order and hierarchy) of a help center in a single call. You must supply the hash returned by the helpCenterIndex query — if the index has changed since you read it, the call will fail so you can re-fetch and re-apply your changes. Requires the helpCenter:edit permission.
MUTATION
updateHelpCenterIndex(input: UpdateHelpCenterIndexInput!): UpdateHelpCenterIndexOutput!Arguments
input
required
Returns
helpCenterIndex
error
Mutation
mutation UpdateHelpCenterIndex($input: UpdateHelpCenterIndexInput!) {
updateHelpCenterIndex(input: $input) {
helpCenterIndex {
helpCenterId
hash
navIndex {
type
id
title
slug
parentId
status
}
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
__typename
}
}
updatedAt {
unixTimestamp
iso8601
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"helpCenterId": "id",
"hash": "string",
"helpCenterIndex": [
{
"type": "ARTICLE",
"entityId": "id"
}
]
}
}Response
{
"data": {
"updateHelpCenterIndex": {
"helpCenterIndex": {
"helpCenterId": "id",
"hash": "string",
"navIndex": [
{
"type": "ARTICLE",
"id": "id",
"title": "string",
"slug": "string",
"parentId": "id",
"status": "PUBLISHED"
}
],
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor"
},
"updatedAt": {
"unixTimestamp": "string",
"iso8601": "string"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

