Loading ...

REST API: Update Page Builder Widget | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Update Page Builder Widget
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 8

REST API: Update Page Builder Widget

0 
 /5
0 (0votes)
Open API Guide
PUT/api/pb/widgets/{WidgetId}

Replaces one Page Builder widget with the object you send, without saving the whole page. Send the complete widget as REST API: Get Page Builder Widget returns it, changed only where you mean to change it. ResponseData is the saved widget, and each successful save adds a version to the page's history. The caller needs permission to update Page Builder pages in the page's space.

Request

Request Header

Header Required Value Description
Authorization YES Bearer YOUR_TOKEN Bearer token for the authenticated user. Learn how to create Bearer tokens.
Content-Type YES application/json Must be set to application/json

Required Parameters

Parameter Type Required Location Description
WidgetID Integer YES Path ID of the widget to update, from the Widgets of REST API: Get Page Builder Page. A value that is not a whole number answers 400.
Content JSON Object YES Body The whole widget object, as REST API: Get Page Builder Widget returns it. It replaces the stored widget rather than merging into it: a body without WidgetTypeID or WidgetTitle answers 500 and saves nothing. AuthorID and UpdatedByUserID are saved as sent. The WidgetID in the path decides which widget changes, and the widget stays on its own page whatever PageID the body carries.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/pb/widgets/6597

Request Body

{
  "AuthorID": 630,
  "DateCreated": "2026-09-27T03:02:55.637",
  "IsSavedWidget": false,
  "IsLocked": false,
  "PageID": 1265,
  "ParentID": 6596,
  "HideContainerBorder": false,
  "ShowWidgetFooter": false,
  "ShowWidgetHeader": false,
  "SortOrder": 1,
  "LoadOrder": 3,
  "TemplateID": 0,
  "UpdatedByUserID": 0,
  "WidgetDependency": "Communifire.Core.RawHtmlWidget, Communifire.Core",
  "WidgetID": 6597,
  "WidgetIDString": "6597",
  "WidgetProperties": "{\"TemplateID\":null,\"RawHtml\":\"<p>Welcome to the new team page.</p>\"}",
  "WidgetTitle": "Raw HTML",
  "WidgetTitleResourceKey": "Raw HTML",
  "WidgetTypeID": 18,
  "WidgetTypeName": "Raw HTML",
  "WidgetTypeIconCSS": "icon-code",
  "IsMobile": false,
  "SavedWidgetID": 0,
  "IsCached": false,
  "SavedWidgetUseCount": 0,
  "EditGlobally": false,
  "IsUpdated": false,
  "TenantID": 1
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "AuthorID": 630,
    "DateCreated": "2026-09-27T03:02:55.637",
    "DateUpdated": "2026-09-27T03:04:44.4345142Z",
    "IsSavedWidget": false,
    "IsLocked": false,
    "PageID": 1265,
    "ParentID": 6596,
    "HideContainerBorder": false,
    "ShowWidgetFooter": false,
    "ShowWidgetHeader": false,
    "SortOrder": 1,
    "LoadOrder": 3,
    "TemplateID": 0,
    "UpdatedByUserID": 0,
    "WidgetDependency": "Communifire.Core.RawHtmlWidget, Communifire.Core",
    "WidgetID": 6597,
    "WidgetIDString": "6597",
    "WidgetProperties": "{\"TemplateID\":null,\"RawHtml\":\"<p>Welcome to the new team page.</p>\"}",
    "WidgetTitle": "Raw HTML",
    "WidgetTitleResourceKey": "Raw HTML",
    "WidgetTypeID": 18,
    "WidgetTypeName": "Raw HTML",
    "WidgetTypeIconCSS": "icon-code",
    "IsMobile": false,
    "SavedWidgetID": 0,
    "IsCached": false,
    "SavedWidgetUseCount": 0,
    "EditGlobally": false,
    "IsUpdated": false,
    "TenantID": 1
  }
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Widget payload is required"
}

Error Handling

Status Code Likely Cause Next Action
400 Bad Request The body is missing or not a widget object (Widget payload is required), or WidgetID in the path is not an integer, which answers {"Message": "The request is invalid."}. Send the full widget object as returned by Get Page Builder Widget.
401 Unauthorized Missing or invalid Bearer token. Check token validity. Learn how to create Bearer tokens →
403 Forbidden The caller lacks the Page Builder update permission for the space of the widget's page, or site-wide for a saved widget (No permission). Call with a token that can edit Page Builder pages there.
404 Not Found No widget has that ID (Widget not found), the widget has no page (Widget's PageID not found), or its page no longer exists (Widget's page not found). Verify the WidgetID with Get Page Builder Widget.
500 Server Error The body is a widget object missing a field the save needs, such as WidgetTypeID or WidgetTitle. Nothing is saved, and the body is empty. Send the whole object from Get Page Builder Widget.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages