Skip to main content

valuesetItemDelete

Permanently delete a value set item from its parent value set.

Removes the item from the value set and any configurations that reference it. This action cannot be undone and may affect dropdown lists or validation rules that depend on this item.

Restrictions: • Items in SYSTEM type value sets cannot be deleted • Operation cannot be reversed once completed • May affect dependent configurations and dropdown lists

Use this mutation with caution when: • Removing obsolete options that are no longer needed • Cleaning up test or development configurations • Consolidating duplicate items within value sets

Possible errors:

  • VALUESET_ITEM_DELETE_ERROR: Failed to delete the value set item due to system error
  • VALUESET_ITEM_NOT_FOUND_ERROR: Value set item with the specified ID does not exist
  • VALUESET_NOT_ALLOWED_TO_MODIFY_ERROR: Attempt to delete item from SYSTEM type value set

AUTH: Role=[configuration.OWNER]

valuesetItemDelete(
  id: Int!
): Boolean!

Arguments​

valuesetItemDelete.id ● Int! non-null scalar​

Unique identifier of the value set item to delete.

Must be a positive integer representing a valid, existing value set item ID. The item must belong to a CUSTOM type value set to allow deletion.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.