Edit website settings available since version 4.0.46 / 3.7.374 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/settings.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Boolean publishWithForcedHttps - (optional) if true then published website will forcefully be redirected to HTTPS protocol; if false then no forced redirection will be applied;
• Boolean forceRedirectEnabled - (optional) possible values:
  • Number 0 - forced redirection will be not be applied to published website;
  • Number 1 - published website will forcefully be redirected to non-WWW domain version;
  • Number 2 - published website will forcefully be redirected to WWW domain version;
• Boolean disableRightClick - (optional) if true then context menu will not appear on published website when right-clicking website area with a mouse;
• Boolean forceSlashes - (optional) if true then published website will forcefully be redirected to URL with trailing slashes at the end (for example URL "" will redirect to ""); if false then no forced redirection will be applied;
• String scriptCommonHead - (optional) custom code for field "Before </head>" for "Common" item;
• String scriptCommonBodyEnd - (optional) custom code for field "Before </body>" for "Common" item;
• String scriptCommonBodyStart - (optional) custom code for field "After </body>" for "Common" item;
• Page Scripts Object scriptPageHead - (optional) custom code for field "Before </head>" for specific pages;
• Page Scripts Object scriptPageBodyEnd - (optional) custom code for field "Before </body>" for specific pages;
• Page Scripts Object scriptPageBodyStart - (optional) custom code for field "After </body>" for specific pages;

• Page Scripts Object - associative array of custom code for specific pages. The object must be of structure:

  {
      "pageId1": "code1",
      "pageId2": "code2",
      ...
  }

  where pageId is ID of page which can be retrieved with Get website pages API method, and code is custom code for fields specified above in description of properties.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;