PRprocess
Page Widgets

Update a page widget

Updates a widget on a draft page revision. PUT semantics: all mutable fields must be provided. Returns the updated widget.

put/pages/{pageId}/revisions/{revisionId}/widgets/{widgetId}

Request

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

Path parameters

pageIdstring required

The ID of the Page

revisionIdstring required

The ID of the Revision

widgetIdstring required

The ID of the Widget

Request body

OR
OR
OR
OR
OR

Response

Example response

{
  "data": {
    "id": "qB2llZ1xDP0BoZxtcpJ9iw",
    "taskId": "qB2llZ1xDP0BoZxtcpJ9iw",
    "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

No recorded changes to this operation across all 16 revisions of this API.