Mutation
mutation DeleteTenantField($input: DeleteTenantFieldInput!) {
deleteTenantField(input: $input) {
tenantField {
id
source
externalFieldId
value {
__typename
... on TenantFieldStringValue {
__typename
}
}
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
__typename
}
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"tenantFieldId": "id"
}
}Response
{
"data": {
"deleteTenantField": {
"tenantField": {
"id": "id",
"source": "string",
"externalFieldId": "id",
"value": {
"__typename": "TenantFieldStringValue"
},
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
deleteTenantField
Clears a tenant’s value for a specific field without removing the field schema itself. Use this to unset a field value while keeping the schema available for other tenants. Requires tenant:edit permission.
MUTATION
deleteTenantField(input: DeleteTenantFieldInput!): DeleteTenantFieldOutput!Arguments
input
required
Returns
tenantField
error
Mutation
mutation DeleteTenantField($input: DeleteTenantFieldInput!) {
deleteTenantField(input: $input) {
tenantField {
id
source
externalFieldId
value {
__typename
... on TenantFieldStringValue {
__typename
}
}
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
__typename
}
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"tenantFieldId": "id"
}
}Response
{
"data": {
"deleteTenantField": {
"tenantField": {
"id": "id",
"source": "string",
"externalFieldId": "id",
"value": {
"__typename": "TenantFieldStringValue"
},
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

