Mutations
updateHelpCenter
Update the settings, branding, or access configuration of an existing help center. Only fields that are provided are updated. Requires the helpCenter:edit permission.
MUTATION
updateHelpCenter(input: UpdateHelpCenterInput!): UpdateHelpCenterOutput!Arguments
input
required
Returns
helpCenter
error
Mutation
mutation UpdateHelpCenter($input: UpdateHelpCenterInput!) {
updateHelpCenter(input: $input) {
helpCenter {
id
type
publicName
internalName
description
domainSettings {
domainName
customDomainName
customDomainNameVerificationTxtRecord {
__typename
}
customDomainNameVerifiedAt {
__typename
}
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"helpCenterId": "id"
}
}Response
{
"data": {
"updateHelpCenter": {
"helpCenter": {
"id": "id",
"type": "PUBLIC",
"publicName": "string",
"internalName": "string",
"description": "string",
"domainSettings": {
"domainName": "string",
"customDomainName": "string",
"customDomainNameVerificationTxtRecord": {
"__typename": "HelpCenterDomainNameVerificationTxtRecord"
},
"customDomainNameVerifiedAt": {
"__typename": "DateTime"
}
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?
⌘I
Mutation
mutation UpdateHelpCenter($input: UpdateHelpCenterInput!) {
updateHelpCenter(input: $input) {
helpCenter {
id
type
publicName
internalName
description
domainSettings {
domainName
customDomainName
customDomainNameVerificationTxtRecord {
__typename
}
customDomainNameVerifiedAt {
__typename
}
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"helpCenterId": "id"
}
}Response
{
"data": {
"updateHelpCenter": {
"helpCenter": {
"id": "id",
"type": "PUBLIC",
"publicName": "string",
"internalName": "string",
"description": "string",
"domainSettings": {
"domainName": "string",
"customDomainName": "string",
"customDomainNameVerificationTxtRecord": {
"__typename": "HelpCenterDomainNameVerificationTxtRecord"
},
"customDomainNameVerifiedAt": {
"__typename": "DateTime"
}
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}
