RECENT UPDATES:
23-Jul-2026 | v7.11 | All new article

Change Log

  • 23-Jul-2026 | v7.11 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

Module Property Management

Create, Retrieve, Update and Delete Module Property Sections via the public API endpoint, as well as a Module's available and visible Properties. Property Management controls how a Module's Properties are grouped into Sections and displayed on the Module Item edit screen in the admin.

GET Module All Properties List

Retrieves a list of all Properties available to the Module, grouped by Type, as a JSON response based on the ID passed in the endpoint URL.

/api/v2/admin/modules/{id}/property-management/all-properties

Data / Response:

N/A

[
  {
    "Type": "string",
    "Fields": [
      {
        "Alias": "string",
        "Name": "string",
        "IsSystem": true,
        "IsMandatory": true,
        "Width": 0,
        "Weight": 0,
        "EditorAlias": "string",
        "PropertyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "RowSetting": "OwnRow"
      }
    ]
  }
]

GET Module Visible Properties List

Retrieves a list of the Module's visible Property Sections and the Properties within them as a JSON response based on the ID passed in the endpoint URL.

/api/v2/admin/modules/{id}/property-management/visible-properties

Data / Response:

N/A

[
  {
    "Alias": "string",
    "Name": "string",
    "Notes": "string",
    "DisplayNotesInline": true,
    "Weight": 0,
    "IsDefault": true,
    "Width": 0,
    "Fields": [
      {
        "Alias": "string",
        "Name": "string",
        "IsSystem": true,
        "IsMandatory": true,
        "Width": 0,
        "Weight": 0,
        "EditorAlias": "string",
        "PropertyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "RowSetting": "OwnRow"
      }
    ],
    "AllowedRoleIds": [
      0
    ]
  }
]

POST Module Property Section Create

Creates a new Module Property Section based on the provided data.

/api/v2/admin/modules/{id}/property-management/section

Data / Response:

{
  "Name": "string",
  "Notes": "string",
  "DisplayNotesInline": true,
  "Weight": 0,
  "Width": 0,
  "Fields": [
    {
      "Alias": "string",
      "Width": 0,
      "Weight": 0,
      "IsMandatory": true,
      "RowSetting": "OwnRow"
    }
  ],
  "AllowedRoleIds": [
    0
  ]
}

{
  "Alias": "string",
  "Name": "string",
  "Notes": "string",
  "DisplayNotesInline": true,
  "Weight": 0,
  "IsDefault": true,
  "Width": 0,
  "Fields": [
    {
      "Alias": "string",
      "Name": "string",
      "IsSystem": true,
      "IsMandatory": true,
      "Width": 0,
      "Weight": 0,
      "EditorAlias": "string",
      "PropertyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "RowSetting": "OwnRow"
    }
  ],
  "AllowedRoleIds": [
    0
  ]
}

PUT Module Property Section Update

Updates an existing Module Property Section based on the ID passed in the endpoint URL and data provided. The Section being updated is identified by the Alias value in the request body.

/api/v2/admin/modules/{id}/property-management/section

Data / Response:

{
  "Alias": "string",
  "Name": "string",
  "Notes": "string",
  "DisplayNotesInline": true,
  "Weight": 0,
  "Width": 0,
  "Fields": [
    {
      "Alias": "string",
      "Width": 0,
      "Weight": 0,
      "IsMandatory": true,
      "RowSetting": "OwnRow"
    }
  ],
  "AllowedRoleIds": [
    0
  ]
}

{
  "Alias": "string",
  "Name": "string",
  "Notes": "string",
  "DisplayNotesInline": true,
  "Weight": 0,
  "IsDefault": true,
  "Width": 0,
  "Fields": [
    {
      "Alias": "string",
      "Name": "string",
      "IsSystem": true,
      "IsMandatory": true,
      "Width": 0,
      "Weight": 0,
      "EditorAlias": "string",
      "PropertyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "RowSetting": "OwnRow"
    }
  ],
  "AllowedRoleIds": [
    0
  ]
}

DELETE Module Property Section Delete

Deletes a single Module Property Section based on the ID and Section alias passed in the endpoint URL.

/api/v2/admin/modules/{id}/property-management/section/{alias}

Data / Response:

N/A

Status 204