Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/ai/proposals/{proposalId}/revert \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Undoes a proposal that has been applied, restoring the values captured before it ran. Gated exactly as approving is — the caller must hold the action's own permission in the proposal's organization — because undoing a change is not a lesser act than making it. ⛔ An action whose effect clears on its own (a cache purge) is a `422` saying so, not a silent success: there is nothing to put back, and reporting one would be a claim that something happened. ⭐ This is also what earns a capability its rung 2. `revert_verified_at` is stamped by a revert that actually RAN, never by a form — the authority ladder wants an event rather than an intention.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
proposalId (path) | Uuid | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
action | string | Yes | — |
conversation_id | Uuid | No | The AI conversation this came out of, or `null` for one raised by a scheduled review. ⭐ Lets a chat surface show its own suggestions without a second endpoint, and lets `/ai` sa… |
action_title | string | Yes | — |
target_label | string | No | — |
rationale | string | No | Why, citing the measurement. This is what a person reads before approving. |
state | AgentProposalState | Yes | — |
mode | AgentProposalMode | Yes | How an approved proposal executes — decided by the authority ladder at the moment of approval, never frozen when the proposal was written. `attended` is a person clicking; `cana… |
reversibility | string<automatic, self_healing, manual> | No | Whether this change can be put back, carried on the proposal itself so a client rendering an undo control does not have to join this list against the capability catalogue — a se… |
approval_means | string | No | — |
outcome | string | No | — |
proposed_by | string | No | — |
created_at | string | Yes | — |
decided_at | object | No | — |
applied_at | object | No | — |
reverted | boolean | No | — |
Errors this endpoint can return
401 · 404 · 422 · 429