PRprocess
File Revisions

Update a file revision

Changed on

Records what changed in a draft and whether the change is material or non-material. This does not replace the document or publish the draft.

put/files/{fileId}/revisions/{revisionId}

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/files/{fileId}/revisions/{revisionId}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

fileIdstring required

File ID

revisionIdstring required

The ID of the Revision

Request body

changeType'Material' | 'NonMaterial' required

Whether the changes in this revision are significant. Material — substantial changes; bumps the major version (e.g. 1.3 → 2.0). NonMaterial — minor edits like wording or typo fixes; bumps the minor version (e.g. 1.3 → 1.4).

changeExplanationstring

Optional human-readable explanation of what changed in this revision; surfaced in revision history.

Response

Example response

{
  "data": {
    "id": "jkBnUsJVEmABoZxtcCRyeQ",
    "createdBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes