Documentation

landing.site.updateFolder

landing.site.updateFolder(
    siteId,
    folderId,
    fields
)

Method updates a folder site.

Parameters

Parameter Description Available from version
siteId Site ID.

Внимание: Requires access permissions to write into specified site.

folderId Folder ID in site.
fields Folder fields:
  • ACTIVE – folder active status (Y/N). Created as inactive by default;
  • TITLE – folder header (name);
  • INDEX_ID –– page ID inside folder to be made as folder index page;
  • CODE – folder symbolic code (portion of folder page URL). Transliterated from folder name by default.

Example

BX24.callMethod(
    'landing.site.updateFolder',
    {
        siteId: 1817,
        folderId: 736,
        fields: {
            TITLE: 'Updated folder'
        }
    },
    function(result)
    {
        if(result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);


© «Bitrix24», 2001-2022
Up