Open API v2 / Custom Modules / Modules

Modules

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

GET/api/v2/admin/modules#

Retrieves a list of modules by using a "where" filtering

Parameters

Wherestring · query

JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.

Order_Bystring · query

Sort field. Prefix with - for descending; comma-separate for tie-breakers.

Semantic_Querystring · query

Natural-language search, ranked by relevance.

Min_Scorenumber · query

Lowest relevance score to include when using Semantic_Query.

Offsetinteger · query

Number of items to skip before returning results. Defaults to 0.

Limitinteger · query

Maximum number of items to return. Defaults to 100.

Response

Idinteger

Unique identifier of the restriction rule. Read-only.

Namestring · nullable

System name of the module (technical name).

Aliasstring · nullable

Alias (nickname) used for programmatic access to the module.

Titlestring · nullable

A user-friendly name for the rule (for example, "Create Module Item").

Notesstring · nullable

Arbitrary technical notes or description of the module's purpose.

MediaFolderstring · nullable

Folder name or path to the directory where media files of this module are stored.

NewItemButtonValuestring · nullable

The text displayed on the button for creating a new module item.

UrlSlugstring · nullable

User-friendly part of the URL for accessing module resources.

Iconstring · nullable

Path to the icon file (usually in SVG format) that visualizes the module in the menu.

LastUpdatedDatestring · date-time

Date and time of the last update to the module configuration. Read-only.

IsDefaultboolean

A boolean flag that indicates whether this module is the default module.

SecureZonesarray of integers

List of security zone identifiers for which this rule applies.

ExtraSettingsobject

Container for additional specific settings.

SiteUserPermissionsobject

User permissions settings.

SpecifyExpiryDateboolean

SiteUserPermissions setting. If true, the system allows (or requires) setting an expiration date for user access rights.

RequiresApprovalboolean

SiteUserPermissions setting. Determines whether user actions require prior approval by an administrator before publication or saving.

FrontendApiRestrictionSettingsarray of objects

An array of objects describing specific restrictions for different types of operations (for example, adding, editing).

AdvancedOptionsobject

Advanced module parameters.

curl "https://your-site.webinone.com/api/v2/admin/modules" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/modules", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/modules",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/modules', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/modules");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Items": [
    {
      "Id": 1,
      "Name": "Example",
      "Alias": "string",
      "Title": "string",
      "Notes": "string",
      "MediaFolder": "string",
      "NewItemButtonValue": "string",
      "UrlSlug": "https://example.com",
      "Icon": "string",
      "LastUpdatedDate": "2026-07-01T00: 00: 00Z",
      "IsDefault": false,
      "SecureZones": [
        0
      ],
      "ExtraSettings": {
        "EnableRollback": false
      },
      "SiteUserPermissions": {
        "SpecifyExpiryDate": false,
        "RequiresApproval": false,
        "FrontendApiRestrictionSettings": [
          {
            "NotificationSettings": {
              "CustomWorkflowIds": null,
              "EmailNotification": null
            },
            "Id": 1,
            "Enable": false,
            "FrontendApiRestrictionType": "AddItems",
            "HasOwnership": false,
            "OwnershipRestriction": "OnlyOwnerAllowed",
            "UserTypeApiRestriction": "LoggedInUser",
            "SecureZones": [
              null
            ],
            "Title": "string"
          }
        ]
      },
      "AdvancedOptions": {
        "ChildModuleId": 1,
        "AllowItemsTreeView": false,
        "AllowItemsSimplifiedTreeView": false,
        "AllowItemsListView": false,
        "AllowMultipleParentItems": false,
        "EnableSubscription": false,
        "EnableRelatedModuleItems": false,
        "DefaultItemsView": "string",
        "RootTreeLevelViewAllowAddItemsOfParentType": false,
        "RootTreeLevelViewAllowAddItemsOfChildType": false,
        "InnerTreeLevelViewAllowAddItemsOfParentType": false,
        "InnerTreeLevelViewAllowAddItemsOfChildType": false,
        "AllowCreatingForeignItems": false
      }
    }
  ],
  "TotalItemsCount": 0
}

POST/api/v2/admin/modules#

Creates a new module

Body parameters

Namestringrequired

Name of the create module.

Aliasstring · nullable

Is a critically important system identifier. Is a static string used by the software to reference the module. Cannot be empty/absent (nullable: false).

Titlestring · nullable

Module title for the interface.

Notesstring · nullable

Free-text notes for internal use.

MediaFolderstring · nullable

This is the folder that is displayed by default in the media manager when selecting content for this module.

NewItemButtonValuestring · nullable

Text that will be displayed on the button for creating a new item.

UrlSlugstring · nullable

Part of the URL path for module items.

Iconstring · nullable

Relative path to the icon file within the system directory or media storage.

LastUpdatedDatestring · date-time

When the record was last updated (ISO 8601). Read-only.

IsDefaultboolean

When enabled, marks this as the site's default module.

SecureZonesarray of integers

Identifiers of the secure zones the module is bound to, controlling which member groups can view its content.

DisableDetailLayoutboolean

This is a logical toggle that determines whether elements of this module will have their own separate page on the site.

MediaFilesUploadFolderstring · nullable

This is a system path to the directory (folder) designed for automatic storage of media files (images, documents, videos) uploaded by users through records of this module.

ExtraSettingsobject

Container for additional module settings, such as change-history rollback.

SiteUserPermissionsobject

User permissions settings.

SpecifyExpiryDateboolean

SiteUserPermissions setting. If true, the system allows (or requires) setting an expiration date for user access rights.

RequiresApprovalboolean

SiteUserPermissions setting. Determines whether user actions require prior approval by an administrator before publication or saving.

FrontendApiRestrictionSettingsarray of objects

An array of objects describing specific restrictions for different types of operations (for example, adding, editing).

AdvancedOptionsobjectrequired

Advanced module settings controlling item hierarchy, tree/list views, subscriptions, and related-item behavior in the admin panel.

Response

Idinteger

Unique identifier of the restriction rule. Read-only.

Namestring · nullable

System name of the module (technical name).

Aliasstring · nullable

Alias (nickname) used for programmatic access to the module.

Titlestring · nullable

A user-friendly name for the rule (for example, "Create Module Item").

Notesstring · nullable

Arbitrary technical notes or description of the module's purpose.

MediaFolderstring · nullable

Folder name or path to the directory where media files of this module are stored.

NewItemButtonValuestring · nullable

The text displayed on the button for creating a new module item.

UrlSlugstring · nullable

User-friendly part of the URL for accessing module resources.

Iconstring · nullable

Path to the icon file (usually in SVG format) that visualizes the module in the menu.

LastUpdatedDatestring · date-time

Date and time of the last update to the module configuration. Read-only.

IsDefaultboolean

A boolean flag that indicates whether this module is the default module.

SecureZonesarray of integers

List of security zone identifiers for which this rule applies.

ExtraSettingsobject

Container for additional specific settings.

SiteUserPermissionsobject

User permissions settings.

SpecifyExpiryDateboolean

SiteUserPermissions setting. If true, the system allows (or requires) setting an expiration date for user access rights.

RequiresApprovalboolean

SiteUserPermissions setting. Determines whether user actions require prior approval by an administrator before publication or saving.

FrontendApiRestrictionSettingsarray of objects

An array of objects describing specific restrictions for different types of operations (for example, adding, editing).

AdvancedOptionsobject

Advanced module parameters.

curl -X POST "https://your-site.webinone.com/api/v2/admin/modules" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Name":"Example","Alias":"string","Title":"string","Notes":"string","MediaFolder":"string","NewItemButtonValue":"string","UrlSlug":"https://example.com","Icon":"string","LastUpdatedDate":"2026-07-01T00:00:00Z","IsDefault":false,"SecureZones":[0],"DisableDetailLayout":false,"MediaFilesUploadFolder":"string","ExtraSettings":{"EnableRollback":false},"SiteUserPermissions":{"SpecifyExpiryDate":false,"RequiresApproval":false,"FrontendApiRestrictionSettings":[{"NotificationSettings":{"CustomWorkflowIds":[0],"EmailNotification":{"EmailContent":"user@example.com","EmailFromAddress":"user@example.com","EmailSubject":"user@example.com","FromName":"Example","TemplateId":1}},"Id":1,"Enable":false,"FrontendApiRestrictionType":"AddItems","HasOwnership":false,"OwnershipRestriction":"OnlyOwnerAllowed","UserTypeApiRestriction":"LoggedInUser","SecureZones":[0],"Title":"string"}]},"AdvancedOptions":{"ChildModuleId":1,"AllowItemsTreeView":false,"AllowItemsSimplifiedTreeView":false,"AllowItemsListView":false,"AllowMultipleParentItems":false,"EnableSubscription":false,"EnableRelatedModuleItems":false,"DefaultItemsView":"string","RootTreeLevelViewAllowAddItemsOfParentType":false,"RootTreeLevelViewAllowAddItemsOfChildType":false,"InnerTreeLevelViewAllowAddItemsOfParentType":false,"InnerTreeLevelViewAllowAddItemsOfChildType":false,"AllowCreatingForeignItems":false}}'

await fetch("https://your-site.webinone.com/api/v2/admin/modules", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Name": "Example",
    "Alias": "string",
    "Title": "string",
    "Notes": "string",
    "MediaFolder": "string",
    "NewItemButtonValue": "string",
    "UrlSlug": "https://example.com",
    "Icon": "string",
    "LastUpdatedDate": "2026-07-01T00:00:00Z",
    "IsDefault": false,
    "SecureZones": [
      0
    ],
    "DisableDetailLayout": false,
    "MediaFilesUploadFolder": "string",
    "ExtraSettings": {
      "EnableRollback": false
    },
    "SiteUserPermissions": {
      "SpecifyExpiryDate": false,
      "RequiresApproval": false,
      "FrontendApiRestrictionSettings": [
        {
          "NotificationSettings": {
            "CustomWorkflowIds": [
              0
            ],
            "EmailNotification": {
              "EmailContent": "user@example.com",
              "EmailFromAddress": "user@example.com",
              "EmailSubject": "user@example.com",
              "FromName": "Example",
              "TemplateId": 1
            }
          },
          "Id": 1,
          "Enable": false,
          "FrontendApiRestrictionType": "AddItems",
          "HasOwnership": false,
          "OwnershipRestriction": "OnlyOwnerAllowed",
          "UserTypeApiRestriction": "LoggedInUser",
          "SecureZones": [
            0
          ],
          "Title": "string"
        }
      ]
    },
    "AdvancedOptions": {
      "ChildModuleId": 1,
      "AllowItemsTreeView": false,
      "AllowItemsSimplifiedTreeView": false,
      "AllowItemsListView": false,
      "AllowMultipleParentItems": false,
      "EnableSubscription": false,
      "EnableRelatedModuleItems": false,
      "DefaultItemsView": "string",
      "RootTreeLevelViewAllowAddItemsOfParentType": false,
      "RootTreeLevelViewAllowAddItemsOfChildType": false,
      "InnerTreeLevelViewAllowAddItemsOfParentType": false,
      "InnerTreeLevelViewAllowAddItemsOfChildType": false,
      "AllowCreatingForeignItems": false
    }
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/modules",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Name": "Example",
        "Alias": "string",
        "Title": "string",
        "Notes": "string",
        "MediaFolder": "string",
        "NewItemButtonValue": "string",
        "UrlSlug": "https://example.com",
        "Icon": "string",
        "LastUpdatedDate": "2026-07-01T00:00:00Z",
        "IsDefault": False,
        "SecureZones": [0],
        "DisableDetailLayout": False,
        "MediaFilesUploadFolder": "string",
        "ExtraSettings": {
            "EnableRollback": False
        },
        "SiteUserPermissions": {
            "SpecifyExpiryDate": False,
            "RequiresApproval": False,
            "FrontendApiRestrictionSettings": [{
                "NotificationSettings": {
                    "CustomWorkflowIds": [0],
                    "EmailNotification": {
                        "EmailContent": "user@example.com",
                        "EmailFromAddress": "user@example.com",
                        "EmailSubject": "user@example.com",
                        "FromName": "Example",
                        "TemplateId": 1
                    }
                },
                "Id": 1,
                "Enable": False,
                "FrontendApiRestrictionType": "AddItems",
                "HasOwnership": False,
                "OwnershipRestriction": "OnlyOwnerAllowed",
                "UserTypeApiRestriction": "LoggedInUser",
                "SecureZones": [0],
                "Title": "string"
            }]
        },
        "AdvancedOptions": {
            "ChildModuleId": 1,
            "AllowItemsTreeView": False,
            "AllowItemsSimplifiedTreeView": False,
            "AllowItemsListView": False,
            "AllowMultipleParentItems": False,
            "EnableSubscription": False,
            "EnableRelatedModuleItems": False,
            "DefaultItemsView": "string",
            "RootTreeLevelViewAllowAddItemsOfParentType": False,
            "RootTreeLevelViewAllowAddItemsOfChildType": False,
            "InnerTreeLevelViewAllowAddItemsOfParentType": False,
            "InnerTreeLevelViewAllowAddItemsOfChildType": False,
            "AllowCreatingForeignItems": False
        }
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/modules', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Name' => 'Example',
        'Alias' => 'string',
        'Title' => 'string',
        'Notes' => 'string',
        'MediaFolder' => 'string',
        'NewItemButtonValue' => 'string',
        'UrlSlug' => 'https://example.com',
        'Icon' => 'string',
        'LastUpdatedDate' => '2026-07-01T00:00:00Z',
        'IsDefault' => false,
        'SecureZones' => [0],
        'DisableDetailLayout' => false,
        'MediaFilesUploadFolder' => 'string',
        'ExtraSettings' => [
            'EnableRollback' => false
        ],
        'SiteUserPermissions' => [
            'SpecifyExpiryDate' => false,
            'RequiresApproval' => false,
            'FrontendApiRestrictionSettings' => [[
                'NotificationSettings' => [
                    'CustomWorkflowIds' => [0],
                    'EmailNotification' => [
                        'EmailContent' => 'user@example.com',
                        'EmailFromAddress' => 'user@example.com',
                        'EmailSubject' => 'user@example.com',
                        'FromName' => 'Example',
                        'TemplateId' => 1
                    ]
                ],
                'Id' => 1,
                'Enable' => false,
                'FrontendApiRestrictionType' => 'AddItems',
                'HasOwnership' => false,
                'OwnershipRestriction' => 'OnlyOwnerAllowed',
                'UserTypeApiRestriction' => 'LoggedInUser',
                'SecureZones' => [0],
                'Title' => 'string'
            ]]
        ],
        'AdvancedOptions' => [
            'ChildModuleId' => 1,
            'AllowItemsTreeView' => false,
            'AllowItemsSimplifiedTreeView' => false,
            'AllowItemsListView' => false,
            'AllowMultipleParentItems' => false,
            'EnableSubscription' => false,
            'EnableRelatedModuleItems' => false,
            'DefaultItemsView' => 'string',
            'RootTreeLevelViewAllowAddItemsOfParentType' => false,
            'RootTreeLevelViewAllowAddItemsOfChildType' => false,
            'InnerTreeLevelViewAllowAddItemsOfParentType' => false,
            'InnerTreeLevelViewAllowAddItemsOfChildType' => false,
            'AllowCreatingForeignItems' => false
        ]
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/modules");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Name\":\"Example\",\"Alias\":\"string\",\"Title\":\"string\",\"Notes\":\"string\",\"MediaFolder\":\"string\",\"NewItemButtonValue\":\"string\",\"UrlSlug\":\"https://example.com\",\"Icon\":\"string\",\"LastUpdatedDate\":\"2026-07-01T00:00:00Z\",\"IsDefault\":false,\"SecureZones\":[0],\"DisableDetailLayout\":false,\"MediaFilesUploadFolder\":\"string\",\"ExtraSettings\":{\"EnableRollback\":false},\"SiteUserPermissions\":{\"SpecifyExpiryDate\":false,\"RequiresApproval\":false,\"FrontendApiRestrictionSettings\":[{\"NotificationSettings\":{\"CustomWorkflowIds\":[0],\"EmailNotification\":{\"EmailContent\":\"user@example.com\",\"EmailFromAddress\":\"user@example.com\",\"EmailSubject\":\"user@example.com\",\"FromName\":\"Example\",\"TemplateId\":1}},\"Id\":1,\"Enable\":false,\"FrontendApiRestrictionType\":\"AddItems\",\"HasOwnership\":false,\"OwnershipRestriction\":\"OnlyOwnerAllowed\",\"UserTypeApiRestriction\":\"LoggedInUser\",\"SecureZones\":[0],\"Title\":\"string\"}]},\"AdvancedOptions\":{\"ChildModuleId\":1,\"AllowItemsTreeView\":false,\"AllowItemsSimplifiedTreeView\":false,\"AllowItemsListView\":false,\"AllowMultipleParentItems\":false,\"EnableSubscription\":false,\"EnableRelatedModuleItems\":false,\"DefaultItemsView\":\"string\",\"RootTreeLevelViewAllowAddItemsOfParentType\":false,\"RootTreeLevelViewAllowAddItemsOfChildType\":false,\"InnerTreeLevelViewAllowAddItemsOfParentType\":false,\"InnerTreeLevelViewAllowAddItemsOfChildType\":false,\"AllowCreatingForeignItems\":false}}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "Name": "Example",
  "Alias": "string",
  "Title": "string",
  "Notes": "string",
  "MediaFolder": "string",
  "NewItemButtonValue": "string",
  "UrlSlug": "https://example.com",
  "Icon": "string",
  "LastUpdatedDate": "2026-07-01T00: 00: 00Z",
  "IsDefault": false,
  "SecureZones": [
    0
  ],
  "ExtraSettings": {
    "EnableRollback": false
  },
  "SiteUserPermissions": {
    "SpecifyExpiryDate": false,
    "RequiresApproval": false,
    "FrontendApiRestrictionSettings": [
      {
        "NotificationSettings": {
          "CustomWorkflowIds": [
            0
          ],
          "EmailNotification": {
            "EmailContent": "user@example.com",
            "EmailFromAddress": "user@example.com",
            "EmailSubject": "user@example.com",
            "FromName": "Example",
            "TemplateId": 1
          }
        },
        "Id": 1,
        "Enable": false,
        "FrontendApiRestrictionType": "AddItems",
        "HasOwnership": false,
        "OwnershipRestriction": "OnlyOwnerAllowed",
        "UserTypeApiRestriction": "LoggedInUser",
        "SecureZones": [
          0
        ],
        "Title": "string"
      }
    ]
  },
  "AdvancedOptions": {
    "ChildModuleId": 1,
    "AllowItemsTreeView": false,
    "AllowItemsSimplifiedTreeView": false,
    "AllowItemsListView": false,
    "AllowMultipleParentItems": false,
    "EnableSubscription": false,
    "EnableRelatedModuleItems": false,
    "DefaultItemsView": "string",
    "RootTreeLevelViewAllowAddItemsOfParentType": false,
    "RootTreeLevelViewAllowAddItemsOfChildType": false,
    "InnerTreeLevelViewAllowAddItemsOfParentType": false,
    "InnerTreeLevelViewAllowAddItemsOfChildType": false,
    "AllowCreatingForeignItems": false
  }
}

GET/api/v2/admin/modules/{id}#

Retrieves a single module

Parameters

idinteger · pathrequired

Module id.

Response

Idinteger

Unique identifier of the restriction rule. Read-only.

Namestring · nullable

System name of the module (technical name).

Aliasstring · nullable

Alias (nickname) used for programmatic access to the module.

Titlestring · nullable

A user-friendly name for the rule (for example, "Create Module Item").

Notesstring · nullable

Arbitrary technical notes or description of the module's purpose.

MediaFolderstring · nullable

Folder name or path to the directory where media files of this module are stored.

NewItemButtonValuestring · nullable

The text displayed on the button for creating a new module item.

UrlSlugstring · nullable

User-friendly part of the URL for accessing module resources.

Iconstring · nullable

Path to the icon file (usually in SVG format) that visualizes the module in the menu.

LastUpdatedDatestring · date-time

Date and time of the last update to the module configuration. Read-only.

IsDefaultboolean

A boolean flag that indicates whether this module is the default module.

SecureZonesarray of integers

List of security zone identifiers for which this rule applies.

ExtraSettingsobject

Container for additional specific settings.

SiteUserPermissionsobject

User permissions settings.

SpecifyExpiryDateboolean

SiteUserPermissions setting. If true, the system allows (or requires) setting an expiration date for user access rights.

RequiresApprovalboolean

SiteUserPermissions setting. Determines whether user actions require prior approval by an administrator before publication or saving.

FrontendApiRestrictionSettingsarray of objects

An array of objects describing specific restrictions for different types of operations (for example, adding, editing).

AdvancedOptionsobject

Advanced module parameters.

curl "https://your-site.webinone.com/api/v2/admin/modules/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/modules/1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/modules/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/modules/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/modules/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "Name": "Example",
  "Alias": "string",
  "Title": "string",
  "Notes": "string",
  "MediaFolder": "string",
  "NewItemButtonValue": "string",
  "UrlSlug": "https://example.com",
  "Icon": "string",
  "LastUpdatedDate": "2026-07-01T00: 00: 00Z",
  "IsDefault": false,
  "SecureZones": [
    0
  ],
  "ExtraSettings": {
    "EnableRollback": false
  },
  "SiteUserPermissions": {
    "SpecifyExpiryDate": false,
    "RequiresApproval": false,
    "FrontendApiRestrictionSettings": [
      {
        "NotificationSettings": {
          "CustomWorkflowIds": [
            0
          ],
          "EmailNotification": {
            "EmailContent": "user@example.com",
            "EmailFromAddress": "user@example.com",
            "EmailSubject": "user@example.com",
            "FromName": "Example",
            "TemplateId": 1
          }
        },
        "Id": 1,
        "Enable": false,
        "FrontendApiRestrictionType": "AddItems",
        "HasOwnership": false,
        "OwnershipRestriction": "OnlyOwnerAllowed",
        "UserTypeApiRestriction": "LoggedInUser",
        "SecureZones": [
          0
        ],
        "Title": "string"
      }
    ]
  },
  "AdvancedOptions": {
    "ChildModuleId": 1,
    "AllowItemsTreeView": false,
    "AllowItemsSimplifiedTreeView": false,
    "AllowItemsListView": false,
    "AllowMultipleParentItems": false,
    "EnableSubscription": false,
    "EnableRelatedModuleItems": false,
    "DefaultItemsView": "string",
    "RootTreeLevelViewAllowAddItemsOfParentType": false,
    "RootTreeLevelViewAllowAddItemsOfChildType": false,
    "InnerTreeLevelViewAllowAddItemsOfParentType": false,
    "InnerTreeLevelViewAllowAddItemsOfChildType": false,
    "AllowCreatingForeignItems": false
  }
}

PUT/api/v2/admin/modules/{id}#

Updates an existing module

Parameters

idinteger · pathrequired

Resource identifier.

Body parameters

Namestringrequired

Name of the edit module.

Aliasstring · nullable

Is a critically important system identifier. Is a static string used by the software to reference the module. Cannot be empty/absent (nullable: false).

Titlestring · nullable

Module title for the interface.

Notesstring · nullable

Free-text notes for internal use.

MediaFolderstring · nullable

This is the folder that is displayed by default in the media manager when selecting content for this module.

NewItemButtonValuestring · nullable

Text that will be displayed on the button for creating a new item.

UrlSlugstring · nullable

Part of the URL path for module items.

Iconstring · nullable

Relative path to the icon file within the system directory or media storage.

LastUpdatedDatestring · date-time

When the record was last updated (ISO 8601). Read-only.

IsDefaultboolean

When enabled, marks this as the site's default module.

SecureZonesarray of integers

Identifiers of the secure zones the module is bound to, controlling which member groups can view its content.

DisableDetailLayoutboolean

This is a logical toggle that determines whether elements of this module will have their own separate page on the site.

MediaFilesUploadFolderstring · nullable

This is a system path to the directory (folder) designed for automatic storage of media files (images, documents, videos) uploaded by users through records of this module.

ExtraSettingsobject

Container for additional module settings, such as change-history rollback.

SiteUserPermissionsobject

User permissions settings.

SpecifyExpiryDateboolean

SiteUserPermissions setting. If true, the system allows (or requires) setting an expiration date for user access rights.

RequiresApprovalboolean

SiteUserPermissions setting. Determines whether user actions require prior approval by an administrator before publication or saving.

FrontendApiRestrictionSettingsarray of objects

An array of objects describing specific restrictions for different types of operations (for example, adding, editing).

AdvancedOptionsobjectrequired

Advanced module settings controlling item hierarchy, tree/list views, subscriptions, and related-item behavior in the admin panel.

Response

Idinteger

Unique identifier of the restriction rule. Read-only.

Namestring · nullable

System name of the module (technical name).

Aliasstring · nullable

Alias (nickname) used for programmatic access to the module.

Titlestring · nullable

A user-friendly name for the rule (for example, "Create Module Item").

Notesstring · nullable

Arbitrary technical notes or description of the module's purpose.

MediaFolderstring · nullable

Folder name or path to the directory where media files of this module are stored.

NewItemButtonValuestring · nullable

The text displayed on the button for creating a new module item.

UrlSlugstring · nullable

User-friendly part of the URL for accessing module resources.

Iconstring · nullable

Path to the icon file (usually in SVG format) that visualizes the module in the menu.

LastUpdatedDatestring · date-time

Date and time of the last update to the module configuration. Read-only.

IsDefaultboolean

A boolean flag that indicates whether this module is the default module.

SecureZonesarray of integers

List of security zone identifiers for which this rule applies.

ExtraSettingsobject

Container for additional specific settings.

SiteUserPermissionsobject

User permissions settings.

SpecifyExpiryDateboolean

SiteUserPermissions setting. If true, the system allows (or requires) setting an expiration date for user access rights.

RequiresApprovalboolean

SiteUserPermissions setting. Determines whether user actions require prior approval by an administrator before publication or saving.

FrontendApiRestrictionSettingsarray of objects

An array of objects describing specific restrictions for different types of operations (for example, adding, editing).

AdvancedOptionsobject

Advanced module parameters.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/modules/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Name":"Example","Alias":"string","Title":"string","Notes":"string","MediaFolder":"string","NewItemButtonValue":"string","UrlSlug":"https://example.com","Icon":"string","LastUpdatedDate":"2026-07-01T00:00:00Z","IsDefault":false,"SecureZones":[0],"DisableDetailLayout":false,"MediaFilesUploadFolder":"string","ExtraSettings":{"EnableRollback":false},"SiteUserPermissions":{"SpecifyExpiryDate":false,"RequiresApproval":false,"FrontendApiRestrictionSettings":[{"NotificationSettings":{"CustomWorkflowIds":[0],"EmailNotification":{"EmailContent":"user@example.com","EmailFromAddress":"user@example.com","EmailSubject":"user@example.com","FromName":"Example","TemplateId":1}},"Id":1,"Enable":false,"FrontendApiRestrictionType":"AddItems","HasOwnership":false,"OwnershipRestriction":"OnlyOwnerAllowed","UserTypeApiRestriction":"LoggedInUser","SecureZones":[0],"Title":"string"}]},"AdvancedOptions":{"ChildModuleId":1,"AllowItemsTreeView":false,"AllowItemsSimplifiedTreeView":false,"AllowItemsListView":false,"AllowMultipleParentItems":false,"EnableSubscription":false,"EnableRelatedModuleItems":false,"DefaultItemsView":"string","RootTreeLevelViewAllowAddItemsOfParentType":false,"RootTreeLevelViewAllowAddItemsOfChildType":false,"InnerTreeLevelViewAllowAddItemsOfParentType":false,"InnerTreeLevelViewAllowAddItemsOfChildType":false,"AllowCreatingForeignItems":false}}'

await fetch("https://your-site.webinone.com/api/v2/admin/modules/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Name": "Example",
    "Alias": "string",
    "Title": "string",
    "Notes": "string",
    "MediaFolder": "string",
    "NewItemButtonValue": "string",
    "UrlSlug": "https://example.com",
    "Icon": "string",
    "LastUpdatedDate": "2026-07-01T00:00:00Z",
    "IsDefault": false,
    "SecureZones": [
      0
    ],
    "DisableDetailLayout": false,
    "MediaFilesUploadFolder": "string",
    "ExtraSettings": {
      "EnableRollback": false
    },
    "SiteUserPermissions": {
      "SpecifyExpiryDate": false,
      "RequiresApproval": false,
      "FrontendApiRestrictionSettings": [
        {
          "NotificationSettings": {
            "CustomWorkflowIds": [
              0
            ],
            "EmailNotification": {
              "EmailContent": "user@example.com",
              "EmailFromAddress": "user@example.com",
              "EmailSubject": "user@example.com",
              "FromName": "Example",
              "TemplateId": 1
            }
          },
          "Id": 1,
          "Enable": false,
          "FrontendApiRestrictionType": "AddItems",
          "HasOwnership": false,
          "OwnershipRestriction": "OnlyOwnerAllowed",
          "UserTypeApiRestriction": "LoggedInUser",
          "SecureZones": [
            0
          ],
          "Title": "string"
        }
      ]
    },
    "AdvancedOptions": {
      "ChildModuleId": 1,
      "AllowItemsTreeView": false,
      "AllowItemsSimplifiedTreeView": false,
      "AllowItemsListView": false,
      "AllowMultipleParentItems": false,
      "EnableSubscription": false,
      "EnableRelatedModuleItems": false,
      "DefaultItemsView": "string",
      "RootTreeLevelViewAllowAddItemsOfParentType": false,
      "RootTreeLevelViewAllowAddItemsOfChildType": false,
      "InnerTreeLevelViewAllowAddItemsOfParentType": false,
      "InnerTreeLevelViewAllowAddItemsOfChildType": false,
      "AllowCreatingForeignItems": false
    }
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/modules/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Name": "Example",
        "Alias": "string",
        "Title": "string",
        "Notes": "string",
        "MediaFolder": "string",
        "NewItemButtonValue": "string",
        "UrlSlug": "https://example.com",
        "Icon": "string",
        "LastUpdatedDate": "2026-07-01T00:00:00Z",
        "IsDefault": False,
        "SecureZones": [0],
        "DisableDetailLayout": False,
        "MediaFilesUploadFolder": "string",
        "ExtraSettings": {
            "EnableRollback": False
        },
        "SiteUserPermissions": {
            "SpecifyExpiryDate": False,
            "RequiresApproval": False,
            "FrontendApiRestrictionSettings": [{
                "NotificationSettings": {
                    "CustomWorkflowIds": [0],
                    "EmailNotification": {
                        "EmailContent": "user@example.com",
                        "EmailFromAddress": "user@example.com",
                        "EmailSubject": "user@example.com",
                        "FromName": "Example",
                        "TemplateId": 1
                    }
                },
                "Id": 1,
                "Enable": False,
                "FrontendApiRestrictionType": "AddItems",
                "HasOwnership": False,
                "OwnershipRestriction": "OnlyOwnerAllowed",
                "UserTypeApiRestriction": "LoggedInUser",
                "SecureZones": [0],
                "Title": "string"
            }]
        },
        "AdvancedOptions": {
            "ChildModuleId": 1,
            "AllowItemsTreeView": False,
            "AllowItemsSimplifiedTreeView": False,
            "AllowItemsListView": False,
            "AllowMultipleParentItems": False,
            "EnableSubscription": False,
            "EnableRelatedModuleItems": False,
            "DefaultItemsView": "string",
            "RootTreeLevelViewAllowAddItemsOfParentType": False,
            "RootTreeLevelViewAllowAddItemsOfChildType": False,
            "InnerTreeLevelViewAllowAddItemsOfParentType": False,
            "InnerTreeLevelViewAllowAddItemsOfChildType": False,
            "AllowCreatingForeignItems": False
        }
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/modules/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Name' => 'Example',
        'Alias' => 'string',
        'Title' => 'string',
        'Notes' => 'string',
        'MediaFolder' => 'string',
        'NewItemButtonValue' => 'string',
        'UrlSlug' => 'https://example.com',
        'Icon' => 'string',
        'LastUpdatedDate' => '2026-07-01T00:00:00Z',
        'IsDefault' => false,
        'SecureZones' => [0],
        'DisableDetailLayout' => false,
        'MediaFilesUploadFolder' => 'string',
        'ExtraSettings' => [
            'EnableRollback' => false
        ],
        'SiteUserPermissions' => [
            'SpecifyExpiryDate' => false,
            'RequiresApproval' => false,
            'FrontendApiRestrictionSettings' => [[
                'NotificationSettings' => [
                    'CustomWorkflowIds' => [0],
                    'EmailNotification' => [
                        'EmailContent' => 'user@example.com',
                        'EmailFromAddress' => 'user@example.com',
                        'EmailSubject' => 'user@example.com',
                        'FromName' => 'Example',
                        'TemplateId' => 1
                    ]
                ],
                'Id' => 1,
                'Enable' => false,
                'FrontendApiRestrictionType' => 'AddItems',
                'HasOwnership' => false,
                'OwnershipRestriction' => 'OnlyOwnerAllowed',
                'UserTypeApiRestriction' => 'LoggedInUser',
                'SecureZones' => [0],
                'Title' => 'string'
            ]]
        ],
        'AdvancedOptions' => [
            'ChildModuleId' => 1,
            'AllowItemsTreeView' => false,
            'AllowItemsSimplifiedTreeView' => false,
            'AllowItemsListView' => false,
            'AllowMultipleParentItems' => false,
            'EnableSubscription' => false,
            'EnableRelatedModuleItems' => false,
            'DefaultItemsView' => 'string',
            'RootTreeLevelViewAllowAddItemsOfParentType' => false,
            'RootTreeLevelViewAllowAddItemsOfChildType' => false,
            'InnerTreeLevelViewAllowAddItemsOfParentType' => false,
            'InnerTreeLevelViewAllowAddItemsOfChildType' => false,
            'AllowCreatingForeignItems' => false
        ]
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/modules/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Name\":\"Example\",\"Alias\":\"string\",\"Title\":\"string\",\"Notes\":\"string\",\"MediaFolder\":\"string\",\"NewItemButtonValue\":\"string\",\"UrlSlug\":\"https://example.com\",\"Icon\":\"string\",\"LastUpdatedDate\":\"2026-07-01T00:00:00Z\",\"IsDefault\":false,\"SecureZones\":[0],\"DisableDetailLayout\":false,\"MediaFilesUploadFolder\":\"string\",\"ExtraSettings\":{\"EnableRollback\":false},\"SiteUserPermissions\":{\"SpecifyExpiryDate\":false,\"RequiresApproval\":false,\"FrontendApiRestrictionSettings\":[{\"NotificationSettings\":{\"CustomWorkflowIds\":[0],\"EmailNotification\":{\"EmailContent\":\"user@example.com\",\"EmailFromAddress\":\"user@example.com\",\"EmailSubject\":\"user@example.com\",\"FromName\":\"Example\",\"TemplateId\":1}},\"Id\":1,\"Enable\":false,\"FrontendApiRestrictionType\":\"AddItems\",\"HasOwnership\":false,\"OwnershipRestriction\":\"OnlyOwnerAllowed\",\"UserTypeApiRestriction\":\"LoggedInUser\",\"SecureZones\":[0],\"Title\":\"string\"}]},\"AdvancedOptions\":{\"ChildModuleId\":1,\"AllowItemsTreeView\":false,\"AllowItemsSimplifiedTreeView\":false,\"AllowItemsListView\":false,\"AllowMultipleParentItems\":false,\"EnableSubscription\":false,\"EnableRelatedModuleItems\":false,\"DefaultItemsView\":\"string\",\"RootTreeLevelViewAllowAddItemsOfParentType\":false,\"RootTreeLevelViewAllowAddItemsOfChildType\":false,\"InnerTreeLevelViewAllowAddItemsOfParentType\":false,\"InnerTreeLevelViewAllowAddItemsOfChildType\":false,\"AllowCreatingForeignItems\":false}}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "Name": "Example",
  "Alias": "string",
  "Title": "string",
  "Notes": "string",
  "MediaFolder": "string",
  "NewItemButtonValue": "string",
  "UrlSlug": "https://example.com",
  "Icon": "string",
  "LastUpdatedDate": "2026-07-01T00: 00: 00Z",
  "IsDefault": false,
  "SecureZones": [
    0
  ],
  "ExtraSettings": {
    "EnableRollback": false
  },
  "SiteUserPermissions": {
    "SpecifyExpiryDate": false,
    "RequiresApproval": false,
    "FrontendApiRestrictionSettings": [
      {
        "NotificationSettings": {
          "CustomWorkflowIds": [
            0
          ],
          "EmailNotification": {
            "EmailContent": "user@example.com",
            "EmailFromAddress": "user@example.com",
            "EmailSubject": "user@example.com",
            "FromName": "Example",
            "TemplateId": 1
          }
        },
        "Id": 1,
        "Enable": false,
        "FrontendApiRestrictionType": "AddItems",
        "HasOwnership": false,
        "OwnershipRestriction": "OnlyOwnerAllowed",
        "UserTypeApiRestriction": "LoggedInUser",
        "SecureZones": [
          0
        ],
        "Title": "string"
      }
    ]
  },
  "AdvancedOptions": {
    "ChildModuleId": 1,
    "AllowItemsTreeView": false,
    "AllowItemsSimplifiedTreeView": false,
    "AllowItemsListView": false,
    "AllowMultipleParentItems": false,
    "EnableSubscription": false,
    "EnableRelatedModuleItems": false,
    "DefaultItemsView": "string",
    "RootTreeLevelViewAllowAddItemsOfParentType": false,
    "RootTreeLevelViewAllowAddItemsOfChildType": false,
    "InnerTreeLevelViewAllowAddItemsOfParentType": false,
    "InnerTreeLevelViewAllowAddItemsOfChildType": false,
    "AllowCreatingForeignItems": false
  }
}

DELETE/api/v2/admin/modules/{id}#

Deletes an existing module

Parameters

idinteger · pathrequired

Module id.

curl -X DELETE "https://your-site.webinone.com/api/v2/admin/modules/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/modules/1", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.delete(
    "https://your-site.webinone.com/api/v2/admin/modules/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/modules/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/modules/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

GET/api/v2/admin/modules/{id}/category-list#

Retrieves a module category list

Parameters

idinteger · pathrequired

Module id.

parentIdinteger · query

ParentId.

Response

Namestring · nullable

System name of the module (technical name).

ItemsCountinteger

Number of items.

FullNamestring · nullable

Full category name including its parent path, showing where the category sits in the hierarchy. Read-only.

Urlstring · nullable

URL.

Idinteger

Unique identifier of the restriction rule. Read-only.

curl "https://your-site.webinone.com/api/v2/admin/modules/1/category-list" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/modules/1/category-list", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/modules/1/category-list",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/modules/1/category-list', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/modules/1/category-list");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

[
  {
    "Name": "Example",
    "ItemsCount": 0,
    "FullName": "Example",
    "Url": "https://example.com",
    "Id": 1
  }
]