Mutation
mutation DeleteSetting($input: DeleteSettingInput!) {
deleteSetting(input: $input) {
previousSetting {
__typename
... on BooleanSetting {
code
booleanValue
scope {
__typename
}
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"code": "string",
"scope": {
"scopeType": "USER"
}
}
}Response
{
"data": {
"deleteSetting": {
"previousSetting": {
"__typename": "BooleanSetting",
"code": "string",
"booleanValue": true,
"scope": {
"__typename": "SettingScope"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
deleteSetting
Delete a stored setting value at the given scope, causing the effective value to revert to the next level in the scope hierarchy (for example, removing a per-channel override exposes the workspace-level default). Returns the value that was removed in previousSetting, or null if no explicit value was stored at that scope. This operation is idempotent — deleting a setting that does not exist returns null without an error.
MUTATION
deleteSetting(input: DeleteSettingInput!): DeleteSettingOutput!Arguments
input
required
Returns
previousSetting
The setting that was removed. Null when no stored value existed at the given scope.
error
Mutation
mutation DeleteSetting($input: DeleteSettingInput!) {
deleteSetting(input: $input) {
previousSetting {
__typename
... on BooleanSetting {
code
booleanValue
scope {
__typename
}
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"code": "string",
"scope": {
"scopeType": "USER"
}
}
}Response
{
"data": {
"deleteSetting": {
"previousSetting": {
"__typename": "BooleanSetting",
"code": "string",
"booleanValue": true,
"scope": {
"__typename": "SettingScope"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?