POST

Restore a version of a requirement

/v1/requirements/{requirement}/revisions/{revision}/restore in the Requirements API.

curl -X POST https://api.example.test/v1/requirements/$REQUIREMENT_ID/revisions/$REVISION_ID/restore \  -H "Authorization: Bearer $TOKEN" \  -H "Idempotency-Key: $(uuidgen)"

Puts the version's captured columns back onto the requirement, status included, and saves. The save writes a new version with the reason restore that names the one put back in restored_from_id; nothing earlier is rewritten. Answers 201 with the version written and emits requirement.restored with both version numbers.

Requires ability

requirement:update

The token must hold this ability, or the call is refused with 403.

Fires one event

requirement.restored

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

restore_revision

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.

In: header

Path Parameters

requirement*string

The requirement, bound by the middleware.

Formatuuid

revision*string

The version to put back, bound by the middleware.

Formatuuid

Header Parameters

Idempotency-Key*string

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Formatuuid

Responses

201Createdapplication/json

The version the restore wrote, 201.

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description. On this endpoint: FORBIDDEN: when the token holder's role on the project does not carry requirement:update.

404Not foundRESOURCE_NOT_FOUNDapplication/json

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred. On this endpoint: RESOURCE_NOT_FOUND: when the version is not the requirement's.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

422Validation failedVALIDATION_FAILEDapplication/json

When the version is identical to the current record, so there is nothing to restore.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X POST "https://example.com/v1/requirements/497f6eca-6276-4993-bfeb-53cbbbba6f08/revisions/497f6eca-6276-4993-bfeb-53cbbbba6f08/restore" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12"

{  "data": {    "id": "f0a1b2c3-d4e5-4f6a-8b7c-8d9e0f1a2b3c",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "revisable_type": "business-rule",    "revisable_id": "d5e6f7a8-b9c0-4d1e-8f2a-3b4c5d6e7f80",    "version": 2,    "reason": "edit",    "actor_kind": "human",    "author_id": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f",    "author_name": "Nimal Fernando",    "ai_feature": null,    "restored_from_id": null,    "restored_from_version": null,    "summary": "Edited: Priority, Examples",    "changed_fields": [      "priority"    ],    "diff": {      "property1": {        "from": "should",        "to": "must"      },      "property2": {        "from": "should",        "to": "must"      }    },    "snapshot": {      "property1": "inference",      "property2": "inference"    },    "created_at": "2026-10-29T10:15:00+00:00"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: RevisionResource;}export interface RevisionResource {  id: string;  project_id: string;  revisable_type: string;  revisable_id: string;  version: number;  reason: string;  actor_kind: string;  author_id: string | null;  author_name: string | null;  ai_feature: string | null;  restored_from_id: string | null;  restored_from_version: number | null;  summary: string | null;  changed_fields: string[];  diff: Record<string, Diff> | null;  snapshot: Record<string, unknown>;  created_at: string | null;}export interface Diff {  from: unknown;  to: unknown;}

How is this guide?

Last updated on October 29, 2026 at 13:13 UTC

Move a requirement

/v1/requirements/{requirement}/status in the Requirements API.

Research API

Research is Heimdall reading the web for what a project's brief never states: what products of this kind commonly do, the laws, regulations and standards that apply in the client's country and industry, the integrations the client will expect, what the market already offers and the security and accessibility expectations the client will be held to.