Commands  ›  General  ›  Unpin All Grids

Unpin All Grids

General writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document must be open. At least one grid must exist in the model. Worksets containing grids must be open for modification.

After it runs

All host grids on open worksets are unpinned. Linked grids and grids on closed worksets remain unchanged. Already-unpinned grids are reported but not modified.

When to use this

Don't use this when

Not for toggling pin state (use ToggleGridsCommand instead). Not for unpinning grids in linked models. Not for autonomous AI execution — requires interactive Revit UI context.

Returns

NameTypeDescription
UnpinnedintNumber of grids that were unpinned
AlreadyUnpinnedintNumber of grids that were already unpinned

Decision flow

check: document.isValid → proceed
check: grids.count > 0 → proceed
action: unpinGridsInOpenWorksets → report results

What you'll see in the chat

on start
Unpinning all host grids in the model...
Releasing pin locks on all grids...
thinking
Finding all host grids in open worksets...
Unpinning each pinned grid...
on success
Unpinned {Unpinned} grids. {AlreadyUnpinned} were already unpinned.
on failure
Grid unpin failed: {error}

REST API

Not yet exposed

This command does not carry a [RestApi] attribute today. Once tagged, this section will auto-populate with:

  • POST /api/v1/commands/unpin_all_grids
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

unpin all grids · unpin grids · unlock grids · free grids · release grid pins
Patterns: unpin * grids · unpin all grids · unlock * grids · free * grids

Related commandsToggleGridsCommand
PillarGeneral