removePropertyFromHierarchy
Remove a property from a hierarchy.
This operation is idempotent - if the property is not in the hierarchy, it will succeed without error. When a property is removed, its descendants are reparented to the removed property's parent. If removing a root node, its children become new root nodes.
Arguments
Input fields for removing a property from a hierarchy.
Returns
RemovePropertyFromHierarchyRemove a property from a hierarchy.
This operation is idempotent - if the property is not in the hierarchy, it will succeed without error. When a property is removed, its descendants are reparented to the removed property's parent. If removing a root node, its children become new root nodes.
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 RemovePropertyFromHierarchy($input: RemovePropertyFromHierarchyInput!) {
removePropertyFromHierarchy(input: $input) {
property {
...PropertyTypeFragment
}
}
}
Variables
{
"input": RemovePropertyFromHierarchyInput
}
Response
{
"data": {
"removePropertyFromHierarchy": {
"property": PropertyType
}
}
}