deletePropertyDescendants
Delete all descendants of a property in a hierarchy.
This permanently deletes all descendant nodes (children, grandchildren, etc.) but keeps the property node itself in the hierarchy. This operation is idempotent - if the property is not in the hierarchy or has no descendants, it will succeed without error.
Arguments
Input fields for deleting descendants from a property.
Returns
DeletePropertyDescendantsDelete all descendants of a property in a hierarchy.
This permanently deletes all descendant nodes (children, grandchildren, etc.) but keeps the property node itself in the hierarchy. This operation is idempotent - if the property is not in the hierarchy or has no descendants, it will succeed without error.
Possible Errors
Allowed Viewers
Customer
Partner User
Third party
Required Permissions
Can manage property hierarchiesQuery Complexity
1Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
mutation DeletePropertyDescendants($input: DeletePropertyDescendantsInput!) {
deletePropertyDescendants(input: $input) {
property {
...PropertyTypeFragment
}
}
}
Variables
{
"input": DeletePropertyDescendantsInput
}
Response
{
"data": {
"deletePropertyDescendants": {
"property": PropertyType
}
}
}