Skip to main content

deleteGrid

Delete a studio-created peer grid so its chunk box no longer blocks overlapping grid creation. Requires app-admin ('manage_apps'). Returns a hybrid response — on success gridId is populated and error is NO_ERROR; on failure gridId is null and error is a UDP-style error code (e.g. GRID_NOT_FOUND, CANNOT_DELETE_DEFAULT_WORLD_GRID, GRID_HAS_NESTED_CHILDREN). The open-by-default world grid and any grid that still contains nested child grids cannot be deleted.

deleteGrid(
  input: DeleteGridInput!
): DeleteGridResponse!

Arguments​

deleteGrid.input ● DeleteGridInput! non-null input​

The app and grid to delete.

Type​

DeleteGridResponse object​

Result of deleteGrid. This is a hybrid result rather than a thrown error: inspect error first. When error is NO_ERROR the call succeeded and gridId is populated; otherwise gridId is null and error explains why.