Site.pro
  • Website Builder
    • Website Builder
    • Online Stores
    • Templates
    • Domains
    • Plugins
    • Languages
    • FAQ
    • Affiliate Program
    • Blog
    • Examples
    • For Design Studios
  • Prices
  • Website Import
  • For Resellers
    • White Label
    • Prices
    • Panels
    • How it Works
    • Free Websites
    • Marketing Kit
    • Mass Import
    • Our Partners
    • Free Website Builder
    • Documentation
    • Blog
    • Growth Hacking
    • Domainity
    • FAQ
  • Contact Sales
  • Website Builder
    • Website BuilderEverybody can easily make a website, landing page or e-commerce.
    • Online StoresSell your goods or services anywhere on the website
    • Templates200+ Awesome Templates. Responsive Design
    • DomainsBuy domain. Connect Your Domain. Transfer Domain.
    • Plugins
    • Languages
    • FAQ
    • Affiliate Program
    • Blog
    • Examples
    • For Design Studios
  • Prices
  • Website Import
  • For ResellersWhite Label
    • White LabelThe most popular white label tool is ideal for reselling
    • PricesStart reselling. Pay for live websites. Free Websites
    • PanelsOne product for all platforms. Download plugin for your panel
    • How it WorksCloud or On-Premises. Recommendations for Builder Server
    • Free WebsitesUnlimited Quantity of Free Websites
    • Marketing KitUse White Label Marketing Kit To Increase Your Sales
    • Mass Import
    • Our Partners
    • Free Website Builder
    • Documentation
    • Blog
    • Growth Hacking
    • Domainity
    • FAQ
  • Contact Sales
  • inputRegister
    Sign Up with Facebook
    Sign Up with Google
    or
  • faceLog In
    Sign in with Facebook Sign in with Google
    or
    Remind password
    A new password will be sent to the specified e-mail address.
    Return to login form
  • $
    • USD — $
    • EUR — €
    • GBP — £
    • BRL — R$
    • PLN — zł
    • INR — ₹
    • TRY — TL
    • AUD — A$
    • CAD — C$
    • CZK — Kč
    • DKK — kr
    • HKD — HK$
    • HUF — Ft
    • ILS — ₪
    • JPY — 円
    • MXN — Mex$
    • NOK — kr
    • NZD — NZ$
    • PHP — ₱
    • RUB — ₽
    • SGD — S$
    • SEK — kr
    • CHF — Fr
    • TWD — NT$
    • THB — ฿
    • CNY — ¥
    • RSD — din
    • BGN — лв.
    • RON — Lei
    • ZAR — R
    • BYN — p.
    • UAH — ₴
    • KZT — ₸
    • CLP — CH$
  • English
    • العربية
    • Azərbaycan
    • Bahasa Indonesia
    • Bahasa Malaysia
    • Беларуская
    • Български
    • Bosanski
    • Castellano
    • Čeština
    • Dansk
    • Deutsch
    • Eesti
    • Ελληνικά
    • English
    • Español
    • 繁體
    • فارسی
    • Français
    • Հայերեն
    • हिन्दी
    • Hrvatski
    • Italiano
    • עברית
    • 简体
    • ქართული
    • Қазақ
    • Latviešu
    • Lietuvių
    • Magyar
    • Nederlands
    • 日本語
    • Norsk
    • O'zbek
    • ภาษาไทย
    • ភាសាខ្មែរ
    • Polski
    • Português (BR)
    • Română
    • Русский
    • Schweizerdeutsch
    • Slovenčina
    • Slovenščina
    • Srpski
    • Suomi
    • Svenska
    • Tiếng Việt
    • Türkçe
    • Украї́нська
    • Wikang Tagalog
    • And additional 2 languages inside Site.pro website builder
Server Requirements
  • Published websites
  • Site.pro IPs
Builder installation / update
On-Premises
  • Server Requirements
  • Installation
  • CRON
  • Update
  • Migration to version v4
  • Extra configuration
  • Manual update
  • Changing PHP version
  • Support
Plugin installation
  • Hosting Panel
    • cPanel
    • DirectAdmin
    • Plesk
    • Sentora/ZPanel
    • ISPmanager
    • InterWorx
    • Vesta
    • Hestia
    • Hosting Controller
    • CentOS Web Panel
    • Custom hosting (API)
  • Billing Panel
    • WHMCS
    • Custom billing (API)
API documentation
  • Builder
    • Create session (SSO)
    • Remove existing session
    • Create website backup
    • Restore website backup
  • Templates
    • List template categories
    • 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
    • Enable/disable Auto Layout
    • Delete website
    • Get website template
    • Get website pages
    • Get website 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
  • Integration with your system
    • Allow/disallow domain in builder
    • Check if domains are allowed in builder
Add-ons documentation
  • For Website
    • Public demo URL
    • Editing plans
    • User registration from public demo
    • Website import
  • 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

Add blocks from compositions 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 http://your-builder-domain.com/api/ 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/add.

http://your-builder-domain.com/api/website-blocks/add (builderApiUrl + "website-blocks/add")
HTTP Basic
[API Username from brand]
[API Password from brand]
POST
application/json
application/json

JSON request Object Properties:

  • String - login hash you received from "Create session" API call;
  • Number or String - page ID to add block to;
  • Array of Object - list of block definitions, definition structure:
    • String - composition ID to use for block creation (composition IDs can be found in a tooltip when opening builder in template editing mode and mouse hovering composition in add composition dialog) (ex. default/232);
    • String - position specifier for where to insert new block, it consists of section name (one of header, body or footer) and position in square brackets (ex. body[0] - insert before 0-th block (at the beginning), body[3] - insert before 3-rd block, body[] - append to the end);
    • Object - (optional) descriptor of how composition elements should be modified before being inserted as block, 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 Website Builder. United States, Washington. Terms of Service