sandbox_design_final

Marks a design final, or undoes that. A design that is not final stays under Ready for you in the person's app; a final one leaves it.

Input Output
designId (dsg_…, from sandbox_draft, sandbox_architecture or sandbox_schema), optional final (default true; false undoes it) ok, designId, final
sandbox_design_final { "designId": "dsg_0f522d044966bd55f74a" }
  • Call it when the person agrees with the design, or before you go on to the next step (from the draft to the architecture or the schema, from a design to building). Otherwise it keeps waiting for them under Ready for you.
  • The person can also mark it final or undo that with one tap on the design's page, with no confirmation.
  • It applies to the latest version. Drawing a new version (the same topic again) puts the design back to not final; call this again once that version is agreed.
  • A final design is not deleted: its link (appUrl) still opens, it still shows on its box's page, and the person can still report on it.
  • The call fails for a design of another account or one that is not there.

The REST equivalent is POST /v1/designs/{designId}/final (REST).


Every tool and topic is listed in the tool reference.