Propose a change
A new version of a definition (`definitionId` and the `baseVersionId` it builds on: the current draft) or a new definition (`name`). The document must fit the kind’s schema (`/v1/schemas/{kind}`) and pass the checks before publish.
POST
A new version of a definition (definitionId and the baseVersionId it builds on: the current draft) or a new definition (name). The document must fit the kind’s schema (/v1/schemas/{kind}) and pass the checks before publish.
apiKey proposeheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: propose
idempotency-key?stringRun this write once: a retry with the same key gets the first answer (24 hours).
Length
1 <= length <= 255application/json- body
kind*stringdefinitionId?stringFormat
uuidbaseVersionId?stringFormat
uuidname?stringLength
1 <= length <= 200definition?unknownsummary*stringLength
1 <= length <= 2000OK
application/json- response
id*stringFormat
uuidkind*stringdefinitionId*|Format
uuidname*stringsummary*stringstatus*stringValue in
"open""approved""rejected"stale*booleanauthor*createdAt*stringFormat
date-timereviewedBy*|nullreviewedAt*|Format
date-timebaseVersionId*|Format
uuidschemaVersion*integerdefinition?unknownpatch*array<>resultVersionId*|Format
uuidreviewNote*string|nullcurl -X POST 'https://api.postforge.dev/v1/change-proposals' \ -H 'Content-Type: application/json' \ -d '{ "kind": "string", "summary": "string"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "definitionId": "058563fe-6949-46e9-9fb3-06a0e3a11f6a", "name": "string", "summary": "string", "status": "open", "stale": true, "author": { "type": "user", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "createdAt": "2019-08-24T14:15:22Z", "reviewedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "reviewedAt": "2019-08-24T14:15:22Z", "baseVersionId": "238d56e0-9ec7-4ebf-bfb2-e487b4bc769c", "schemaVersion": 0, "definition": null, "patch": [ { "op": "add", "path": "string", "value": null } ], "resultVersionId": "5bdef736-5d13-4b91-8666-e0cb14973657", "reviewNote": "string"}