Help Center/Plan Configurator & Compensation Models/How to edit a plan definition and save the draft
Plan Configurator & Compensation Models•Last updated: 2026-10-20•4 min read

How to edit a plan definition and save the draft

Edit the JSON definition of a draft version from the Plan Studio and save it. Saving resets any approvals and never activates the plan.

Have questions or need step-by-step guidance on this topic?

Ask AI Copilot

Step-by-Step Procedure

1

Select the plan and version

Pick the plan in the left library (use "Search plans..." to filter), then click the version button, for example "v2 DRAFT", at the top of the right panel.

2

Click "Edit definition"

The button appears only for editable versions when you hold plan.edit. A "Definition JSON" text area opens with the full definition.

3

Change the JSON

Edit the values you need. The plan id is fixed to the plan you selected, and the owner defaults to you if left blank.

4

Click "Save draft"

A valid definition is saved and the page shows "Draft saved (still a draft: saving never activates)." Invalid JSON shows a "JSON:" error and nothing is saved. "Cancel" closes the editor without saving.

5

Re-read the version panel

The content hash changes, validation findings are recomputed, and any approvals already recorded for the old content are cleared. A version that was REJECTED or FAILED VALIDATION returns to DRAFT.

Expected Operational Outcome

The draft holds your changes, shows fresh validation findings and has no approvals. Its state is DRAFT.

Troubleshooting & Failure Modes

Symptom: "Edit definition" is not shown
Likely Cause: The version is frozen (IN REVIEW, APPROVED, ACTIVE and so on) or you lack plan.edit.
Resolution: Create a new version of the plan (see the guide on new versions and clones) and edit that.
Symptom: Error that the version is FROZEN
Likely Cause: The version left the editable states while the editor was open.
Resolution: Reload, then create a new version.

Was this guide helpful?

Help us refine our platform documentation