Site.pro Site.pro
  • AI Website BuilderAI Website Builder
    • AI Website BuilderAI Website Builder
    • Online StoresOnline Stores
    • PricesPrices
    • CollaborationCollaboration
    • Website ImportWebsite Import
    • PluginsPlugins
    • Website BuilderWebsite Builder
    • TemplatesTemplates
    • For Design StudiosFor Design Studios
    • Useful LinksUseful Links
    • Affiliate ProgramAffiliate Program
    • We Build for YouWe Build for You
    • ExamplesExamples
    • LanguagesLanguages
  • DomainsDomains
    • Register Domain NameRegister Domain Name
    • Migrate DomainsMigrate Domains
    • For Domain InvestorsFor Domain Investors
    • Domain ZonesDomain Zones
    • DomainityDomainity
    • FAQ: DomainsFAQ: Domains
    • Popular Domain ZonesPopular Domain Zones
    • .com.com
    • .org.org
    • .net.net
    • .us.us
    • .co.co
  • EmailEmail
    • Free EmailFree Email
    • Email for BusinessEmail for Business
    • PricesPrices
    • Transfer EmailsTransfer Emails
    • Custom Domain EmailCustom Domain Email
    • FAQ: EmailFAQ: Email
    • Popular FAQsPopular FAQs
    • Email SetupEmail Setup
    • Auto ReplyAuto Reply
    • Auto ForwardingAuto Forwarding
    • Spam ProtectionSpam Protection
  • Accounting SoftwareAccounting Software
    • Accounting SoftwareAccounting Software
    • ModulesModules
    • PricesPrices
    • Integrations, APIIntegrations, API
    • Accounting Companies (391)Accounting Companies (391)
    • Software Integrators (52)Software Integrators (52)
    • Affiliate PartnersAffiliate Partners
    • Useful LinksUseful Links
    • Business TypesBusiness Types
    • Use CasesUse Cases
    • Accounting CompaniesAccounting Companies
    • Sole ProprietorSole Proprietor
    • InvoicingInvoicing
    • FarmerFarmer
    • E-commerceE-commerce
  • For ResellersFor Resellers
    • White LabelWhite Label
    • Revenue ShareRevenue Share
    • PricesPrices
    • PanelsPanels
    • How it WorksHow it Works
    • Marketing MaterialsMarketing Materials
    • Mass ImportMass Import
    • Our PartnersOur Partners
    • Reselling ExamplesReselling Examples
    • DocumentationDocumentation
    • Free WebsitesFree Websites
  • LearnLearn
    • Knowledge BaseKnowledge Base
    • BlogBlog
    • Growth HackingGrowth Hacking
    • For HostingsFor Hostings
    • For EducationFor Education
    • Website Сreation TutorialWebsite Сreation Tutorial
    • Teaching Institutions (70)Teaching Institutions (70)
    • Accounting Courses WorldwideAccounting Courses Worldwide
  • AI Website BuilderAI Website Builder
    • AI Website BuilderAI Website BuilderAI creates websites for you
    • Online StoresOnline StoresBuild online stores
    • PricesPricesAdvanced Features
    • CollaborationCollaborationCo-create websites live
    • Website ImportWebsite ImportImport Any Website
    • PluginsPluginsBuilder plugin and functions
    • Website BuilderWebsite BuilderKey Features
    • TemplatesTemplates200+ Awesome Templates
    • For Design StudiosFor Design StudiosBenefits for Design Studios
    • Useful LinksUseful Links
    • Affiliate ProgramAffiliate Program
    • We Build for YouWe Build for You
    • ExamplesExamples
    • LanguagesLanguages
  • DomainsDomains
    • Register Domain NameRegister Domain NameDomain registration, parking, transfer
    • Migrate DomainsMigrate DomainsTransfer. Connect. Renew
    • For Domain InvestorsFor Domain InvestorsDiscount on all domains
    • Domain ZonesDomain ZonesBuy New Domain Name
    • DomainityDomainityDomain usage by country
    • FAQ: DomainsFAQ: DomainsFind Answer
    • Popular Domain ZonesPopular Domain Zones
    • .com.com
    • .org.org
    • .net.net
    • .us.us
    • .co.co
  • EmailEmail
    • Free EmailFree EmailCreate email
    • Email for BusinessEmail for BusinessAdvanced features & protection
    • PricesPricesCheap email hosting
    • Transfer EmailsTransfer EmailsMigrate your mailboxes
    • Custom Domain EmailCustom Domain EmailEmail address with your domain
    • FAQ: EmailFAQ: EmailFind Answer
    • Popular FAQsPopular FAQs
    • Email SetupEmail Setup
    • Auto ReplyAuto Reply
    • Auto ForwardingAuto Forwarding
    • Spam ProtectionSpam Protection
  • Accounting SoftwareAccounting Software
    • Accounting SoftwareAccounting SoftwareCloud based ERP
    • ModulesModulesMain accounting software modules
    • PricesPrices30 days free trial
    • Integrations, APIIntegrations, APIIntegration with external systems
    • Accounting Companies (391)Accounting Companies (391)Choose your partner for accounting
    • Software Integrators (52)Software Integrators (52)Pick your integrations partner
    • Affiliate PartnersAffiliate PartnersPartners and Affiliate program
    • Useful LinksUseful LinksCalculators and Calendars
    • Business TypesBusiness TypesUse Cases
    • Use CasesUse Cases
    • Accounting CompaniesAccounting Companies
    • Sole ProprietorSole Proprietor
    • InvoicingInvoicing
    • FarmerFarmer
    • E-commerceE-commerce
  • For ResellersWhite LabelFor ResellersWhite Label
    • White LabelWhite LabelCustomise Builder
    • Revenue ShareRevenue ShareEarn 50% from each upgrade
    • PricesPricesRevenue Share. White Label
    • PanelsPanelsOne product for all platforms
    • How it WorksHow it WorksCloud or On-Premises
    • Marketing MaterialsMarketing MaterialsVideo. Mockups. Blocks
    • Mass ImportMass Import
    • Our PartnersOur Partners
    • Reselling ExamplesReselling Examples
    • DocumentationDocumentation
    • Free WebsitesFree Websites
  • LearnLearn
    • Knowledge BaseKnowledge BaseFAQ, Tutorial, Video
    • BlogBlogSite.pro Blog
    • Growth HackingGrowth HackingBoost your sales
    • For HostingsFor HostingsTips on marketing
    • For EducationFor EducationTraining. Tutorials
    • Website Сreation TutorialWebsite Сreation Tutorial
    • Teaching Institutions (70)Teaching Institutions (70)
    • Accounting Courses WorldwideAccounting Courses Worldwide
  • RegisterRegister
    Site.pro

    Create Your Account

    Get started — free and easy!

    Register

    By proceeding, you accept our Terms of Service and Privacy Policy
  • Log inLog in
    Site.pro

    Welcome back!

    Access your work space

    Log in

    New user? Create account
    Forgot password?
  • $
    $
  • EnglishEnglish
Server Requirements
  • Published websites
  • Site.pro IPs
Builder installation / update
On-Premises
  • Server Requirements
  • Installation
  • CRON
  • Update
  • Migration to version v4
  • Collaboration Service
  • Extra configuration
  • Manual update
  • Changing PHP version
  • Support
Plugin installation
  • Hosting Panel
    • cPanel
    • DirectAdmin
    • Plesk
    • Sentora/ZPanel
    • ISPmanager
    • InterWorx
    • Vesta
    • Hosting Controller
    • Control Web Panel
    • Hestia
    • LiveConfig
    • Webuzo
    • Custom hosting (API)
  • Billing Panel
    • WHMCS
    • Blesta
    • Upmind
    • Custom billing (API)
API documentation
  • Builder
    • Create session (SSO)
    • Remove existing session
    • Create website backup
    • Restore website backup
  • Templates
    • List template categories
    • List template category tags
    • List templates
    • Get page types available in templates
  • Import
    • Import website
    • Get website import status
    • Import website block
    • Get website block import status
    • Check if imported website is owned by user
  • Websites
    • Create website
    • Modify website
    • Rename website
    • Publish website
    • Edit website pages
    • Edit website settings
    • Delete website
    • Get website template
    • Get website pages
    • Get website variables
    • Get template variables
    • Get website settings
    • Add pages to website
    • Duplicate pages in website
    • Remove pages from website
  • Website Blocks
    • Create empty website
    • Modify website
    • Inspect website
    • Add empty page
    • Modify page
    • Remove page
    • Inspect page
    • Inspect composition
    • Modification descriptor structure by element type
    • Add blocks from compositions
    • Remove blocks
    • Move blocks
    • Modify blocks
    • Inspect block
  • Licenses
    • Get list of published websites
    • Get statistics of publications/openings
    • Block/unblock published website
    • Controlling IP list
    • Read/add/delete hosting plans
  • Integration with your system
    • Allow/disallow domain in builder
    • Check if domains are allowed in builder
  • FAQ
    • Get posts
    • Get categories
Add-ons documentation
  • For Website
    • Public demo URL
    • Editing plans
    • User registration from public demo
    • Website import
    • Generate with AI
  • For Builder
    • Adding custom templates
    • Adding custom builder plugins
    • Scripts
For developers
  • Programming reference
  • Directory structure
  • Meta information (main.json)
  • Frontend logic (main.js)
  • Element template (main.html)
  • Backend logic (main.php)
  • Plugin testing
  • Custom element plugin
  • E-commerce plugin
  • Overriding UI
  • Other examples
Change Log
API documentation → Website Blocks

Modify blocks available since version 4.0.58 On-Premises

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore [API URL will appear after you log in or sign up] in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/modify.

[API URL will appear after you log in or sign up] (builderApiUrl + "website-blocks/modify")
HTTP Basic
[API Username will appear after you log in or sign up]
[API Password will appear after you log in or sign up]
POST
application/json
application/json

JSON request Object Properties:

  • String - login hash you received from "Create session" API call;
  • Number - page ID to modify blocks at;
  • Object - map of blocks to modify, where field name is block position specifier that consists of section name (one of header, body or footer) and position in square brackets (ex. body[0] - modify 0-th block, body[3] - modify 3-rd block) and field value is descriptor object of how block elements should be modified, where field name is composition elements referenceId and value is modification descriptor object (modification descriptor object will be different depending on element type);

JSON response Object Properties:

  • Boolean - if true then action executed successfully else failed;
  • String - (optional) if action failed then this will contain error message;
© Site.pro 2011. Website Builder. United States.
Contact SalesContact SalesTerms of ServiceTerms of ServicePrivacy PolicyPrivacy PolicyCookie SettingsCookie Settings