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.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Number or String pageId - page ID to add block to;
• Array of Object items - list of block definitions, definition structure:
  • String compositionId - 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 - 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 data - (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 ok - if true then action executed successfully else failed;
• String error - (optional) if action failed then this will contain error message;