Mutation
mutation DeleteTenant($input: DeleteTenantInput!) {
deleteTenant(input: $input) {
tenant {
id
name
externalId
url
source
tier {
id
name
externalId
color
isDefault
defaultPriority
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"tenantIdentifier": {}
}
}Response
{
"data": {
"deleteTenant": {
"tenant": {
"id": "id",
"name": "string",
"externalId": "string",
"url": "string",
"source": "API",
"tier": {
"id": "id",
"name": "string",
"externalId": "string",
"color": "string",
"isDefault": true,
"defaultPriority": 1
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
deleteTenant
Permanently deletes a tenant, unlinking it from all customers and removing its fields.
Threads that were associated with the tenant retain a tombstone reference but are no longer routed through it.
The tenant can be identified by either its Plain tenantId or its externalId.
Requires the tenant:delete permission.
MUTATION
deleteTenant(input: DeleteTenantInput!): DeleteTenantOutput!Arguments
input
required
Returns
tenant
error
Mutation
mutation DeleteTenant($input: DeleteTenantInput!) {
deleteTenant(input: $input) {
tenant {
id
name
externalId
url
source
tier {
id
name
externalId
color
isDefault
defaultPriority
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"tenantIdentifier": {}
}
}Response
{
"data": {
"deleteTenant": {
"tenant": {
"id": "id",
"name": "string",
"externalId": "string",
"url": "string",
"source": "API",
"tier": {
"id": "id",
"name": "string",
"externalId": "string",
"color": "string",
"isDefault": true,
"defaultPriority": 1
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

