Developers

page-builder-sandwich abilities reference

page-builder-sandwich registers its actions with the WordPress Abilities API. The same abilities are MCP tools on the site's own server and REST routes under /wp-json/wp-abilities/v1. This page is generated from the plugin's own registry.

User guide: connect an AI app

Endpoints

MCP over HTTP (streamable)

https://example.com/wp-json/pbs/v1/mcp

MCP over WP-CLI (standard input and output)

wp mcp-adapter serve --server=page-builder-sandwich --user=<login>

REST: list the abilities

/wp-json/wp-abilities/v1/abilities?category=page-builder-sandwich

REST: run an ability

/wp-json/wp-abilities/v1/abilities/<name>/run

Authentication and permissions

HTTP requests authenticate with a WordPress application password (HTTP Basic). Connecting to the MCP server needs the capability shown below; every ability then checks its own permission, per object. Read-only abilities run with GET and their input in the query string; the others with POST and a JSON body {"input": {…}}.

Examples

# REST: run an ability
curl -u your-username:your-application-password \
  "https://example.com/wp-json/wp-abilities/v1/abilities/pbs/get-breakpoints/run"
# MCP (JSON-RPC over HTTP, after "initialize")
{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"pbs-get-breakpoints","arguments":{}}}

All abilities

Generated from the plugin's abilities.json, which is itself generated from a running site; a test fails when the two disagree.

AbilityWhat it doesEditionRESTPermissionParameters
pbs/activate-custom-font
pbs-activate-custom-font
Turn on an uploaded font (Pro)
Makes an uploaded custom font (a font file in the media library, by id) available in the font pickers.
Pro editionPOST …/abilities/pbs/activate-custom-font/runedit_theme_options (the REST route's own check)id: integer (required)
pbs/add-local-font
pbs-add-local-font
Self-host a font
Downloads a Google font family (family, weights, italic) and serves it from this site.
Free editionPOST …/abilities/pbs/add-local-font/runmanage_options (the REST route's own check)family: string (required), weights: array, italic: boolean
pbs/add-section
pbs-add-section
Add a section to a page
Adds a ready-made section to a page: at the start, at the end, or after the section at a given position.
Free editionPOST …/abilities/pbs/add-section/runedit_post on that pageid: integer (required), section: string (required), position: start|end|after, after: integer
pbs/apply-brand-kit
pbs-apply-brand-kit
Apply the brand kit (Pro)
Applies the saved brand kit's colours and fonts to the site design.
Pro editionPOST …/abilities/pbs/apply-brand-kit/runedit_theme_options (the REST route's own check)none
pbs/apply-kit
pbs-apply-kit
Import a website kit
Imports a website kit's pages (all of them, or the ones named), optionally publishing them, setting the home page and adding them to a menu. Importing again updates the same pages.
Free editionPOST …/abilities/pbs/apply-kit/runedit_pages and publish_pages; manage_options to set the home pageslug: string (required), pages: array, publish: boolean, front: boolean, menu: boolean
pbs/apply-replace
pbs-apply-replace
Apply a find-and-replace (Pro)
Applies a previewed job. Every changed post keeps a backup for pbs/undo-replace.
Pro editionPOST …/abilities/pbs/apply-replace/runmanage_options (the REST route's own check)id: string (required)
pbs/build-landing-page
pbs-build-landing-page
Build a landing page
A guided workflow: the agent picks sections that fit your business, builds the page as a draft and writes its text.
Free editionPOST …/abilities/pbs/build-landing-page/runedit_pagesbusiness: string (required)
pbs/build-pages
pbs-build-pages
Build several pages
Creates up to 50 pages in one call, each from sections and/or block content. Each page is checked and created on its own; the answer lists every page made and every one refused, with the reason.
Pro editionPOST …/abilities/pbs/build-pages/runedit_pages; each page is checked on its own (publish_pages to publish)pages: array (required)
pbs/connect-adobe-fonts
pbs-connect-adobe-fonts
Connect Adobe Fonts (Pro)
Connects an Adobe Fonts (Typekit) web project by its kit id, so its fonts appear in the font pickers.
Pro editionPOST …/abilities/pbs/connect-adobe-fonts/runedit_theme_options (the REST route's own check)kit: string (required)
pbs/connect-support
pbs-connect-support
Connect to support
Connects this site to Zinn Digital® support (name, email, consent).
Free editionPOST …/abilities/pbs/connect-support/runmanage_options (the REST route's own check)email: string (required), name: string, consent: boolean (required)
pbs/convert-post
pbs-convert-post
Convert one legacy page
Converts one 5.x page to blocks (backed up first).
Free editionPOST …/abilities/pbs/convert-post/runthe REST route's own per-item permission checkid: string (required)
pbs/create-class
pbs-create-class
Create a global class (Pro)
Creates a reusable global style class: label, slug and its styles (s).
Pro editionPOST …/abilities/pbs/create-class/runedit_theme_options (the REST route's own check)label: string (required), slug: string, s: object
pbs/create-page
pbs-create-page
Create a page
Creates a page from sections (see pbs/list-sections) and/or block content. A new page is a draft unless another status is asked for.
Free editionPOST …/abilities/pbs/create-page/runedit_pages; publish_pages to publish or make privatetitle: string (required), status: draft|pending|publish|private, sections: array, content: string
pbs/create-team
pbs-create-team
Create a library team (Agency)
Creates a team library (name) that other sites can join with an invite code.
Pro editionPOST …/abilities/pbs/create-team/runmanage_options (the REST route's own check)name: string (required)
pbs/deactivate-custom-font
pbs-deactivate-custom-font
Turn off an uploaded font (Pro)
Removes a custom font (by slug) from the font pickers.
Pro editionPOST …/abilities/pbs/deactivate-custom-font/runedit_theme_options (the REST route's own check)slug: string (required)
pbs/delete-class
pbs-delete-class
Delete a global class (Pro)
Deletes a global class. Elements that used it keep their content and lose its styles.
Pro editionPOST …/abilities/pbs/delete-class/runedit_theme_options (the REST route's own check)id: string (required)
pbs/delete-icon
pbs-delete-icon
Delete an uploaded icon
Removes an uploaded icon; blocks that used it keep their own copy.
Free editionPOST …/abilities/pbs/delete-icon/rundelete_post (the REST route's own check)id: string (required)
pbs/delete-library-item
pbs-delete-library-item
Delete a cloud library design (Pro)
Deletes a design from the cloud library.
Pro editionPOST …/abilities/pbs/delete-library-item/runedit_posts (the REST route's own check)item: string (required), team: string
pbs/delete-page
pbs-delete-page
Move a page to the trash
Moves a page to the trash. It can be restored from Pages, Trash for 30 days.
Free editionPOST …/abilities/pbs/delete-page/rundelete_post on that pageid: integer (required)
pbs/delete-team
pbs-delete-team
Delete a library team (Agency)
Deletes a team and every design in its library.
Pro editionPOST …/abilities/pbs/delete-team/runmanage_options (the REST route's own check)team: string (required)
pbs/disconnect-support
pbs-disconnect-support
Disconnect from support
Disconnects this site from support.
Free editionPOST …/abilities/pbs/disconnect-support/runmanage_options (the REST route's own check)none
pbs/duplicate-class
pbs-duplicate-class
Duplicate a global class (Pro)
Copies a global class under a new id.
Pro editionPOST …/abilities/pbs/duplicate-class/runedit_theme_options (the REST route's own check)id: string (required)
pbs/duplicate-page
pbs-duplicate-page
Duplicate a page
Copies a page (its title, content and template) into a new draft.
Free editionPOST …/abilities/pbs/duplicate-page/runedit_post on the page and edit_pagesid: integer (required), title: string
pbs/export-designs
pbs-export-designs
Export designs and settings
Exports the chosen templates and patterns (ids) and, optionally, settings as one package for another site.
Free editionPOST …/abilities/pbs/export-designs/runmanage_options (the REST route's own check)ids: array, settings: boolean
pbs/generate-page
pbs-generate-page
Write a page with AI
Builds a page from sections (given, or chosen by AI from the section library) and has AI rewrite all of its text for your brief, keeping the design. Uses the AI provider set up in the plugin's AI settings. The page is a draft unless another status is asked for.
Pro editionPOST …/abilities/pbs/generate-page/runedit_pages; publish_pages to publish; the AI settings' role and spending rulesbrief: string (required), title: string, sections: array, status: draft|pending|publish|private
pbs/get-block
pbs-get-block
Describe a builder block
Returns one block's settings (attributes with their types, choices and defaults), what it supports, which blocks it may contain, and a ready-to-use example in block markup.
Free editionGET …/abilities/pbs/get-block/runedit_postsname: string (required)
pbs/get-breakpoints
pbs-get-breakpoints
Read the responsive breakpoints
Returns the tablet and mobile widths (and custom breakpoints in Pro) the responsive controls use.
Free editionGET …/abilities/pbs/get-breakpoints/runedit_theme_options (the REST route's own check)none
pbs/get-design-globals
pbs-get-design-globals
Read the site design
Returns the site-wide colours and fonts (heading and body) every block uses, as the Site design screen shows them.
Free editionGET …/abilities/pbs/get-design-globals/runedit_theme_options (the REST route's own check)none
pbs/get-design-system
pbs-get-design-system
Read the design system (Pro)
Returns the Pro design system: global classes, variables, design tokens, dark mode, brand kit and custom fonts.
Pro editionGET …/abilities/pbs/get-design-system/runedit_theme_options (the REST route's own check)none
pbs/get-diagnostics
pbs-get-diagnostics
Read the site diagnostics
Returns the diagnostics a support ticket would carry: versions, active plugins, limits and recent errors.
Free editionGET …/abilities/pbs/get-diagnostics/runmanage_options (the REST route's own check)none
pbs/get-library-account
pbs-get-library-account
Read the cloud library account (Pro)
Returns the cloud library's storage use, plan quota and team facts.
Pro editionGET …/abilities/pbs/get-library-account/runedit_posts (the REST route's own check)none
pbs/get-library-item
pbs-get-library-item
Get a cloud library design (Pro)
Returns one saved design, ready to insert on this site (its images brought into the media library).
Pro editionGET …/abilities/pbs/get-library-item/runedit_posts (the REST route's own check)item: string (required), team: string
pbs/get-library-storage
pbs-get-library-storage
Read the own-storage settings (Pro)
Returns the bring-your-own R2/S3 storage settings (the secret is never returned).
Pro editionGET …/abilities/pbs/get-library-storage/runmanage_options (the REST route's own check)none
pbs/get-licence
pbs-get-licence
Read the licence
Returns this site's Page Builder Sandwich plan, licence state, renewal date and what the plan includes.
Free editionGET …/abilities/pbs/get-licence/runmanage_options (the REST route's own check)none
pbs/get-maintenance
pbs-get-maintenance
Read maintenance mode (Pro)
Returns maintenance / coming-soon mode: mode, page, retry-after and which roles still see the site.
Pro editionGET …/abilities/pbs/get-maintenance/runmanage_options (the REST route's own check)none
pbs/get-migration
pbs-get-migration
Read the legacy migration
Returns the 5.x content conversion's progress and report.
Free editionGET …/abilities/pbs/get-migration/runthe REST route's own per-item permission checknone
pbs/get-newsletter-keys
pbs-get-newsletter-keys
Read the newsletter connection (Pro)
Says whether a Mailchimp key is saved (the key itself is never returned).
Pro editionGET …/abilities/pbs/get-newsletter-keys/runedit_posts (the REST route's own check)none
pbs/get-page
pbs-get-page
Read a page
Returns a page's title, status, links and block content, and the sections (top-level blocks) it is made of.
Free editionGET …/abilities/pbs/get-page/runedit_post on that pageid: integer (required)
pbs/get-replace-job
pbs-get-replace-job
Preview a find-and-replace (Pro)
Returns a job's matches, page by page, to review before applying.
Pro editionGET …/abilities/pbs/get-replace-job/runmanage_options (the REST route's own check)id: string (required)
pbs/get-reviews-sources
pbs-get-reviews-sources
Read the reviews sources (Pro)
Returns the Google and Trustpilot sources the Reviews block shows.
Pro editionGET …/abilities/pbs/get-reviews-sources/runmanage_options (the REST route's own check)none
pbs/get-roles
pbs-get-roles
Read builder permissions (Pro)
Returns which roles may use the builder, design, code and templates (client mode).
Pro editionGET …/abilities/pbs/get-roles/runmanage_options (the REST route's own check)none
pbs/get-settings
pbs-get-settings
Read the plugin settings
Returns the front-end class prefix, the beta-updates state and whether AI agents (MCP) are allowed.
Free editionGET …/abilities/pbs/get-settings/runmanage_options (the REST route's own check)none
pbs/get-support-connection
pbs-get-support-connection
Read the support connection
Says whether this site is connected to Zinn Digital® support, and as whom.
Free editionGET …/abilities/pbs/get-support-connection/runmanage_options (the REST route's own check)refresh: boolean
pbs/get-white-label
pbs-get-white-label
Read white label (Agency)
Returns the white-label settings: on or off, the name shown and which users still see the original.
Pro editionGET …/abilities/pbs/get-white-label/runmanage_options (the REST route's own check)none
pbs/import-designs
pbs-import-designs
Import designs and settings
Imports a package made by pbs/export-designs (dryRun first to see what would change; mode: skip or replace; media; settings).
Free editionPOST …/abilities/pbs/import-designs/runmanage_options (the REST route's own check)package: object (required), mode: skip|replace|duplicate, settings: boolean, media: boolean, dryRun: boolean
pbs/invite-team-member
pbs-invite-team-member
Invite a site to a team (Agency)
Creates a single-use invite code (role: read or write; label; days valid). The code is shown once.
Pro editionPOST …/abilities/pbs/invite-team-member/runmanage_options (the REST route's own check)team: string (required), role: read|write, days: integer, label: string
pbs/join-team
pbs-join-team
Join a team (Pro)
Joins a team library with an invite code.
Pro editionPOST …/abilities/pbs/join-team/runmanage_options (the REST route's own check)code: string (required)
pbs/leave-team
pbs-leave-team
Leave a team (Pro)
Leaves the team library this site joined.
Pro editionPOST …/abilities/pbs/leave-team/runmanage_options (the REST route's own check)none
pbs/list-blocks
pbs-list-blocks
List the builder blocks
Lists every Page Builder Sandwich block this site can use (Pro blocks too when Pro is active): name, title, category and description. Use pbs/get-block for a block's settings, then put the block in a page's content.
Free editionGET …/abilities/pbs/list-blocks/runedit_postssearch: string
pbs/list-forms
pbs-list-forms
List forms
Lists the forms built with the Form block and the form plugins it can embed.
Free editionGET …/abilities/pbs/list-forms/runedit_posts (the REST route's own check)none
pbs/list-kits
pbs-list-kits
List website kits
Lists the website kits (a set of ready-made pages for one kind of business) this site can import.
Free editionGET …/abilities/pbs/list-kits/runedit_pages and publish_pagesrefresh: boolean
pbs/list-library-items
pbs-list-library-items
List cloud library designs (Pro)
Lists the designs saved to the cloud library (kind: section, page or pattern; team: a team's library).
Pro editionGET …/abilities/pbs/list-library-items/runedit_posts (the REST route's own check)team: string, kind: |section|page|style
pbs/list-local-fonts
pbs-list-local-fonts
List self-hosted fonts
Lists the Google fonts this site hosts itself (downloaded once, served from the site, no request to Google).
Free editionGET …/abilities/pbs/list-local-fonts/runmanage_options (the REST route's own check)none
pbs/list-lottie
pbs-list-lottie
List Lottie animations (Pro)
Lists the uploaded Lottie animations.
Pro editionGET …/abilities/pbs/list-lottie/runedit_posts (the REST route's own check)none
pbs/list-pages
pbs-list-pages
List pages
Lists the pages you can edit, newest first, with an optional search.
Free editionGET …/abilities/pbs/list-pages/runedit_pages; only pages the user can edit are listedsearch: string, status: any|draft|pending|publish|private, page: integer, per_page: integer
pbs/list-replace-jobs
pbs-list-replace-jobs
List find-and-replace jobs (Pro)
Lists the site-wide find-and-replace jobs and their state.
Pro editionGET …/abilities/pbs/list-replace-jobs/runmanage_options (the REST route's own check)none
pbs/list-sections
pbs-list-sections
List sections
Lists the ready-made sections (hero, features, FAQ, testimonials, call to action and more) that can be added to a page.
Free editionGET …/abilities/pbs/list-sections/runedit_pagessearch: string
pbs/list-support-access
pbs-list-support-access
List temporary support logins
Lists the temporary support users granted to our team and when each expires.
Free editionGET …/abilities/pbs/list-support-access/runmanage_options (the REST route's own check)none
pbs/list-team-members
pbs-list-team-members
List team members (Pro)
Lists the sites in a team and their access.
Pro editionGET …/abilities/pbs/list-team-members/runmanage_options (the REST route's own check)team: string (required)
pbs/list-teams
pbs-list-teams
List library teams (Pro)
Lists the teams this site belongs to or owns.
Pro editionGET …/abilities/pbs/list-teams/runmanage_options (the REST route's own check)none
pbs/list-transferable
pbs-list-transferable
List what can be exported
Lists the templates, patterns and settings that can be exported to another site.
Free editionGET …/abilities/pbs/list-transferable/runmanage_options (the REST route's own check)none
pbs/list-uploaded-icons
pbs-list-uploaded-icons
List uploaded icons
Lists the SVG icons uploaded to the icon library, newest first.
Free editionGET …/abilities/pbs/list-uploaded-icons/runedit_posts (the REST route's own check)page: integer, per_page: integer
pbs/move-section
pbs-move-section
Move a section
Moves a section of a page from one position to another (0-based, as pbs/get-page lists them).
Free editionPOST …/abilities/pbs/move-section/runedit_post on that pageid: integer (required), from: integer (required), to: integer (required)
pbs/open-support-ticket
pbs-open-support-ticket
Open a support ticket
Files a support ticket (subject, message, kind, email) with this site's diagnostics; access_days and credentials optionally grant our team temporary access.
Free editionPOST …/abilities/pbs/open-support-ticket/runmanage_options (the REST route's own check)none
pbs/refresh-reviews
pbs-refresh-reviews
Refresh reviews now (Pro)
Fetches the latest Trustpilot reviews now instead of waiting for the daily refresh.
Pro editionPOST …/abilities/pbs/refresh-reviews/runmanage_options (the REST route's own check)none
pbs/remove-block
pbs-remove-block
Remove a block from a page
Removes one block (a whole section, or a block inside one) from a page, found by its path. The page's previous version stays in its revisions.
Free editionPOST …/abilities/pbs/remove-block/runedit_post on that pageid: integer (required), path: array (required)
pbs/remove-library-storage
pbs-remove-library-storage
Stop using your own storage (Pro)
Removes the bring-your-own storage settings; the plan storage is used again.
Pro editionPOST …/abilities/pbs/remove-library-storage/runmanage_options (the REST route's own check)none
pbs/remove-local-font
pbs-remove-local-font
Remove a self-hosted font
Deletes a self-hosted font family's files.
Free editionPOST …/abilities/pbs/remove-local-font/runmanage_options (the REST route's own check)family: string (required)
pbs/remove-team-member
pbs-remove-team-member
Remove a team member (Agency)
Removes a site from a team.
Pro editionPOST …/abilities/pbs/remove-team-member/runmanage_options (the REST route's own check)team: string (required), member: string (required)
pbs/revoke-support-access
pbs-revoke-support-access
Revoke temporary support logins
Removes temporary support users now (ids).
Free editionPOST …/abilities/pbs/revoke-support-access/runmanage_options (the REST route's own check)ids: array (required)
pbs/save-library-item
pbs-save-library-item
Save a design to the cloud library (Pro)
Saves block markup (title, kind, markup, styles, tags) to your cloud library or a team's; images are packed with it.
Pro editionPOST …/abilities/pbs/save-library-item/runedit_posts (the REST route's own check)team: string, kind: section|page|style (required), title: string (required), tags: array, markup: string, styles: object
pbs/set-library-storage
pbs-set-library-storage
Use your own storage (Pro)
Saves bring-your-own storage: provider (r2 or s3), bucket, region, endpoint, prefix, key_id, secret, enabled.
Pro editionPOST …/abilities/pbs/set-library-storage/runmanage_options (the REST route's own check)none
pbs/set-maintenance
pbs-set-maintenance
Change maintenance mode (Pro)
Turns maintenance (503) or coming-soon mode on or off (mode), with the page to show (page_id), retry_after and the roles that bypass it.
Pro editionPOST …/abilities/pbs/set-maintenance/runmanage_options (the REST route's own check)mode: off|maintenance|coming_soon, page_id: integer, roles: array, retry_after: integer
pbs/set-newsletter-keys
pbs-set-newsletter-keys
Connect Mailchimp (Pro)
Saves (or, with an empty value, removes) the Mailchimp API key the newsletter block uses.
Pro editionPOST …/abilities/pbs/set-newsletter-keys/runmanage_options (the REST route's own check)mailchimp: string (required)
pbs/set-reviews-sources
pbs-set-reviews-sources
Change the reviews sources (Pro)
Sets the Google place and Trustpilot business the Reviews block reads.
Pro editionPOST …/abilities/pbs/set-reviews-sources/runmanage_options (the REST route's own check)google: object, trustpilot: object
pbs/set-roles
pbs-set-roles
Change builder permissions (Pro)
Sets per role what the builder allows (roles), e.g. a content-only client role.
Pro editionPOST …/abilities/pbs/set-roles/runmanage_options (the REST route's own check)roles: object (required)
pbs/set-white-label
pbs-set-white-label
Change white label (Agency)
Turns white label on or off and sets the name clients see (enabled, name, agency_users).
Pro editionPOST …/abilities/pbs/set-white-label/runmanage_options (the REST route's own check)none
pbs/start-migration
pbs-start-migration
Convert legacy content
Starts (or restarts) converting every 5.x page to blocks; each post is backed up first.
Free editionPOST …/abilities/pbs/start-migration/runthe REST route's own per-item permission checknone
pbs/start-replace
pbs-start-replace
Find and replace across the site (Pro)
Starts a block-safe find-and-replace (find, replace, kind: text, link or colour; match_case; types). Nothing changes until pbs/apply-replace.
Pro editionPOST …/abilities/pbs/start-replace/runmanage_options (the REST route's own check)find: string (required), replace: string, kind: text|link|colour, types: array, match_case: boolean
pbs/start-trial
pbs-start-trial
Start the free Pro trial
Starts the 14-day Page Builder Sandwich Pro trial for this site (no payment needed).
Free editionPOST …/abilities/pbs/start-trial/runmanage_options (the REST route's own check)none
pbs/test-library-storage
pbs-test-library-storage
Test your own storage (Pro)
Writes, reads and deletes a test object in your own storage and reports each step.
Pro editionPOST …/abilities/pbs/test-library-storage/runmanage_options (the REST route's own check)none
pbs/undo-convert-post
pbs-undo-convert-post
Undo one conversion
Restores one converted page from its backup.
Free editionPOST …/abilities/pbs/undo-convert-post/runthe REST route's own per-item permission checkid: string (required)
pbs/undo-migration
pbs-undo-migration
Undo the legacy migration
Restores every converted post from its backup.
Free editionPOST …/abilities/pbs/undo-migration/runthe REST route's own per-item permission checknone
pbs/undo-replace
pbs-undo-replace
Undo a find-and-replace (Pro)
Restores the posts a job changed (a post edited since keeps its edit).
Pro editionPOST …/abilities/pbs/undo-replace/runmanage_options (the REST route's own check)id: string (required)
pbs/update-block
pbs-update-block
Change one block's settings
Changes the settings (attributes) of one block inside a page, found by its path; attributes you send are merged over the current ones. Works on blocks the site renders from their settings; for a block whose HTML is saved in the page, send new markup with pbs/update-page.
Free editionPOST …/abilities/pbs/update-block/runedit_post on that pageid: integer (required), path: array (required), attributes: object (required)
pbs/update-brand-kit
pbs-update-brand-kit
Change the brand kit (Pro)
Saves the brand kit: name, logo, colours, heading and body fonts, and the brand voice AI writing uses.
Pro editionPOST …/abilities/pbs/update-brand-kit/runedit_theme_options (the REST route's own check)name: string, logo: integer, colors: array, headingFont: string, bodyFont: string, voice: string
pbs/update-breakpoints
pbs-update-breakpoints
Change the responsive breakpoints
Changes the tablet and mobile widths in pixels; with Pro, custom extra breakpoints.
Free editionPOST …/abilities/pbs/update-breakpoints/runedit_theme_options (the REST route's own check)tablet: integer, mobile: integer, custom: array
pbs/update-class
pbs-update-class
Change a global class (Pro)
Changes a global class's label, slug or styles; every element using it updates.
Pro editionPOST …/abilities/pbs/update-class/runedit_theme_options (the REST route's own check)id: string (required), label: string, slug: string, s: object
pbs/update-dark-mode
pbs-update-dark-mode
Change dark mode (Pro)
Sets dark mode (mode: off, auto or toggle) and its colours.
Pro editionPOST …/abilities/pbs/update-dark-mode/runedit_theme_options (the REST route's own check)mode: device|light|dark (required), colors: object
pbs/update-design-globals
pbs-update-design-globals
Change the site design
Changes the site-wide colours (colors), fonts (fonts, headingFont, bodyFont). Every page picks the change up; the theme's theme.json is kept in sync.
Free editionPOST …/abilities/pbs/update-design-globals/runedit_theme_options (the REST route's own check)colors: object, fonts: object, bodyFont: string, headingFont: string
pbs/update-page
pbs-update-page
Update a page
Changes a page's title, status or block content. Content you send replaces the page's content.
Free editionPOST …/abilities/pbs/update-page/runedit_post on that page; publish_pages to publish or make privateid: integer (required), title: string, status: draft|pending|publish|private, sections: array, content: string
pbs/update-settings
pbs-update-settings
Change the plugin settings
Changes the front-end class prefix (1 to 8 lowercase letters or digits, starting with a letter) and/or turns AI agents (MCP) on or off (mcp: false removes every ability and the MCP endpoint).
Free editionPOST …/abilities/pbs/update-settings/runmanage_options (the REST route's own check)prefix: string, mcp: boolean
pbs/update-tokens
pbs-update-tokens
Change the design tokens (Pro)
Changes the spacing, radius and shadow scales (space, radius, shadow), or resets them (reset).
Pro editionPOST …/abilities/pbs/update-tokens/runedit_theme_options (the REST route's own check)space: array, radius: array, shadow: array, reset: boolean
pbs/update-variables
pbs-update-variables
Change the CSS variables (Pro)
Replaces the site's design variables (variables: a list of name and value).
Pro editionPOST …/abilities/pbs/update-variables/runedit_theme_options (the REST route's own check)variables: array (required)
pbs/upload-icon
pbs-upload-icon
Upload an icon
Adds an SVG icon (name, svg markup) to the icon library; the SVG is sanitised first.
Free editionPOST …/abilities/pbs/upload-icon/runupload_files (the REST route's own check)name: string (required), svg: string (required)
pbs/upload-lottie
pbs-upload-lottie
Upload a Lottie animation (Pro)
Validates a Lottie JSON document (json, name) and publishes it as a static file for the Lottie block.
Pro editionPOST …/abilities/pbs/upload-lottie/runupload_files (the REST route's own check)name: string (required), json: string (required)