PRprocess
File Revisions

Publish a file revision

Changed on

Makes your draft the current published version and keeps the previous version in the file's history. When approval workflows are enabled and the file requires review, only its owner or an administrator can publish it. Set acknowledgmentsRequired to true to request acknowledgments from the file's recipients; it defaults to false.

post/files/{fileId}/revisions/{revisionId}/publish

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/files/{fileId}/revisions/{revisionId}/publish
  • 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

acknowledgmentsRequiredboolean required

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