Open API v2 / Custom Modules / Module Item Draft

Module Item Draft

→

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/module-items/draft/{id}#

Retrieves a module item draft

Parameters

idinteger · pathrequired

Resource identifier.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

Urlstring · nullable

URL-friendly identifier.

ItemRatinginteger

Average rating of the object.

UrlListarray of strings

A list of relative URLs (slugs) that lead to detailed pages or resources for specific module elements.

LastUpdatedDatestring · date-time

The date and time the object was last updated. Read-only.

ItemCategoriesIdListarray of integers

A list of unique identifiers (IDs) of the categories to which this item belongs.

SiteSearchKeywordsStringstring · nullable

Additional keywords for this draft item, joined into a single comma-separated string, used to improve internal site search relevance.

IsActiveDraftboolean

A flag indicating the current draft status of the object.

EventPropertiesobject

An object that contains additional metadata or specific properties associated with an event.

ProductPropertiesobject

Product Features Collection.

SmallImagestring · nullable

Path to the product's small (thumbnail) image.

LargeImagestring · nullable

Path to the product's large (full-size) image.

OnSaleboolean

When enabled, the product is marked as being on sale.

IsGiftVoucherboolean

When enabled, the product is treated as a gift voucher rather than a physical or digital good.

ProductWeightnumber

Physical weight of the product, used for shipping calculations.

ProductWidthnumber

Physical width of the product, used for shipping and packaging.

ProductHeightnumber

Physical height of the product, used for shipping and packaging.

ProductDepthnumber

Physical depth of the product, used for shipping and packaging.

EnableDropShippingboolean

Whether enable drop shipping is on.

UnitTypestring · nullable

Label for the unit in which the product is sold (for example, piece, kg, box).

MinimumUnitsinteger

Smallest quantity a customer may order in a single purchase.

MaximumUnitsinteger

Largest quantity a customer may order in a single purchase.

RecurringTypeenum

Billing frequency when the product is sold as a recurring subscription. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly.Possible values: NoneDailyWeeklyFortnightlyMonthlyQuarterlyHalfYearlyYearly

IsShippableboolean

When enabled, the product requires shipping and shipping options are applied at checkout.

IsDownloadableboolean

When enabled, the product delivers a downloadable file after purchase.

NumberOfPossibleDownloadsinteger

How many times a buyer may download the file after purchasing a downloadable product.

Supplierinteger

Identifier of the supplier associated with this product.

IsHideboolean

When enabled, the product is hidden from the storefront.

InStockinteger

Current number of units available in stock.

IsDisableboolean

When enabled, the product is disabled and cannot be ordered.

IsGroupedProductboolean

When enabled, the product is a grouped product that bundles other products together.

DownloadableFileLinkstring · nullable

Path or link to the file delivered when the product is downloadable.

ParentNamestring · nullable

Parent object or category name.

ParentUrlstring · nullable

Relative or absolute URL path to the parent object's page.

Namestring

Name of the module item draft.

UrlSlugstring

URL-friendly identifier.

ParentIdinteger

Identifier of the direct parent item.

Enabledboolean

Indicates whether the item is active and visible in the system.

ReleaseDatestring · date-time

Date and time when the item becomes publicly available.

ExpiryDatestring · date-time

Date and time when the item expires and is no longer available.

Descriptionstring · nullable

Textual description of the item.

Weightinginteger

Numeric priority value used for ordering or ranking items.

DisableForSiteSearchboolean

Specifies whether the item should be excluded from the site search index.

SKUCodestring · nullable

Stock Keeping Unit identifier.

CreatedByMemberIdinteger

Identifier of the member who created the item.

Authorinteger

IIdentifier of the author associated with the item.

ModuleIdinteger

Identifier of the related module.

TemplateIdinteger

Identifier of the template used to render the item.

LayoutIdinteger

Identifier of the layout applied to the item.

Parentsarray of integers

Array (integer)- an array of parent category/element IDs.

ItemCategoriesarray of strings

Array (string)- list of category identifiers or names assigned to the item.

ItemTagsarray of strings

Array (string)- list of tags associated with the item for classification and filtering.

SiteSearchKeywordsarray of strings

Additional keywords used to improve search relevance for this item.

CustomPropertiesobject · nullable

An object containing additional attributes specific to a given content type.

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

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

import requests

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

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

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

Response · 200

{
  "Id": 1,
  "Url": "https://example.com",
  "ItemRating": 0,
  "UrlList": [
    "string"
  ],
  "LastUpdatedDate": "2026-07-01T00: 00: 00Z",
  "ItemCategoriesIdList": [
    0
  ],
  "SiteSearchKeywordsString": "string",
  "IsActiveDraft": false,
  "EventProperties": {
    "HideWhenFull": false,
    "AllowMultipleSubscriptionPerEmail": false,
    "Capacity": 0,
    "Allocation": 0,
    "EventDateStart": "2026-07-01T00: 00: 00Z",
    "EventDateEnd": "2026-07-01T00: 00: 00Z"
  },
  "ProductProperties": {
    "SmallImage": "string",
    "LargeImage": "string",
    "OnSale": false,
    "IsGiftVoucher": false,
    "ProductWeight": 10,
    "ProductWidth": 0,
    "ProductHeight": 0,
    "ProductDepth": 0,
    "EnableDropShipping": false,
    "UnitType": "string",
    "MinimumUnits": 0,
    "MaximumUnits": 0,
    "RecurringType": "None",
    "IsShippable": false,
    "IsDownloadable": false,
    "NumberOfPossibleDownloads": 0,
    "Supplier": 0,
    "IsHide": false,
    "InStock": 0,
    "IsDisable": false,
    "IsGroupedProduct": false,
    "DownloadableFileLink": "string"
  },
  "ParentName": "Example",
  "ParentUrl": "https://example.com",
  "Name": "Example",
  "UrlSlug": "https://example.com",
  "ParentId": 1,
  "Enabled": false,
  "ReleaseDate": "2026-07-01T00: 00: 00Z",
  "ExpiryDate": "2026-07-01T00: 00: 00Z",
  "Description": "string",
  "Weighting": 10,
  "DisableForSiteSearch": false,
  "SKUCode": "string",
  "CreatedByMemberId": 1,
  "Author": 0,
  "ModuleId": 1,
  "TemplateId": 1,
  "LayoutId": 1,
  "Parents": [
    0
  ],
  "ItemCategories": [
    "string"
  ],
  "ItemTags": [
    "string"
  ],
  "SiteSearchKeywords": [
    "string"
  ],
  "CustomProperties": {}
}

PUT/api/v2/admin/module-items/draft/{id}#

Updates an existing module item draft

Parameters

idinteger · pathrequired

Resource identifier.

Body parameters

EventPropertiesobject

Event-specific settings (dates, capacity, booking rules) applied when the item represents an event.

ProductPropertiesobject

Product-specific settings (pricing, stock, dimensions, shipping) applied when the item represents a product.

SmallImagestring · nullable

Path to the product's small (thumbnail) image.

LargeImagestring · nullable

Path to the product's large (full-size) image.

OnSaleboolean

When enabled, the product is marked as being on sale.

IsGiftVoucherboolean

When enabled, the product is treated as a gift voucher rather than a physical or digital good.

ProductWeightnumber

Physical weight of the product, used for shipping calculations.

ProductWidthnumber

Physical width of the product, used for shipping and packaging.

ProductHeightnumber

Physical height of the product, used for shipping and packaging.

ProductDepthnumber

Physical depth of the product, used for shipping and packaging.

EnableDropShippingboolean

Whether enable drop shipping is on.

UnitTypestring · nullable

Label for the unit in which the product is sold (for example, piece, kg, box).

MinimumUnitsinteger

Smallest quantity a customer may order in a single purchase.

MaximumUnitsinteger

Largest quantity a customer may order in a single purchase.

RecurringTypeenum

IsShippableboolean

When enabled, the product requires shipping and shipping options are applied at checkout.

IsDownloadableboolean

When enabled, the product delivers a downloadable file after purchase.

NumberOfPossibleDownloadsinteger

How many times a buyer may download the file after purchasing a downloadable product.

Supplierinteger

Identifier of the supplier associated with this product.

IsHideboolean

When enabled, the product is hidden from the storefront.

InStockinteger

Current number of units available in stock.

IsDisableboolean

When enabled, the product is disabled and cannot be ordered.

IsGroupedProductboolean

When enabled, the product is a grouped product that bundles other products together.

DownloadableFileLinkstring · nullable

Path or link to the file delivered when the product is downloadable.

Namestringrequired

Name of the module item request update.

UrlSlugstringrequired

URL-friendly identifier.

ParentIdinteger

Identifier of the direct parent item.

Enabledboolean

Indicates whether the item is active and visible in the system. By default - true.

ReleaseDatestring · date-time

Date and time when the item becomes publicly available.

ExpiryDatestring · date-time

Date and time when the item expires and is no longer available.

Descriptionstring · nullable

Textual description of the item.

Weightinginteger

Numeric priority value used for ordering or ranking items.

DisableForSiteSearchboolean

Specifies whether the item should be excluded from the site search index. By default - true.

SKUCodestring · nullable

Stock Keeping Unit identifier.

CreatedByMemberIdinteger

Identifier of the member who created the item.

Authorinteger

IIdentifier of the author associated with the item.

ModuleIdintegerrequired

Identifier of the related module.

TemplateIdinteger

Identifier of the template used to render the item.

LayoutIdinteger

Identifier of the layout applied to the item.

Parentsarray of integers

Array (integer) - an array of parent category/element IDs.

ItemCategoriesarray of strings

Array (string)- list of category identifiers or names assigned to the item.

ItemTagsarray of strings

Array (string)- list of tags associated with the item for classification and filtering.

SiteSearchKeywordsarray of strings

Additional keywords used to improve search relevance for this item.

CustomPropertiesobject · nullable

An object containing additional attributes specific to a given content type.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

Urlstring · nullable

URL-friendly identifier.

ItemRatinginteger

Average rating of the object.

UrlListarray of strings

A list of relative URLs (slugs) that lead to detailed pages or resources for specific module elements.

LastUpdatedDatestring · date-time

The date and time the object was last updated. Read-only.

ItemCategoriesIdListarray of integers

A list of unique identifiers (IDs) of the categories to which this item belongs.

SiteSearchKeywordsStringstring · nullable

Additional keywords for this draft item, joined into a single comma-separated string, used to improve internal site search relevance.

IsActiveDraftboolean

A flag indicating the current draft status of the object.

EventPropertiesobject

An object that contains additional metadata or specific properties associated with an event.

ProductPropertiesobject

Product Features Collection.

SmallImagestring · nullable

Path to the product's small (thumbnail) image.

LargeImagestring · nullable

Path to the product's large (full-size) image.

OnSaleboolean

When enabled, the product is marked as being on sale.

IsGiftVoucherboolean

When enabled, the product is treated as a gift voucher rather than a physical or digital good.

ProductWeightnumber

Physical weight of the product, used for shipping calculations.

ProductWidthnumber

Physical width of the product, used for shipping and packaging.

ProductHeightnumber

Physical height of the product, used for shipping and packaging.

ProductDepthnumber

Physical depth of the product, used for shipping and packaging.

EnableDropShippingboolean

Whether enable drop shipping is on.

UnitTypestring · nullable

Label for the unit in which the product is sold (for example, piece, kg, box).

MinimumUnitsinteger

Smallest quantity a customer may order in a single purchase.

MaximumUnitsinteger

Largest quantity a customer may order in a single purchase.

RecurringTypeenum

IsShippableboolean

When enabled, the product requires shipping and shipping options are applied at checkout.

IsDownloadableboolean

When enabled, the product delivers a downloadable file after purchase.

NumberOfPossibleDownloadsinteger

How many times a buyer may download the file after purchasing a downloadable product.

Supplierinteger

Identifier of the supplier associated with this product.

IsHideboolean

When enabled, the product is hidden from the storefront.

InStockinteger

Current number of units available in stock.

IsDisableboolean

When enabled, the product is disabled and cannot be ordered.

IsGroupedProductboolean

When enabled, the product is a grouped product that bundles other products together.

DownloadableFileLinkstring · nullable

Path or link to the file delivered when the product is downloadable.

ParentNamestring · nullable

Parent object or category name.

ParentUrlstring · nullable

Relative or absolute URL path to the parent object's page.

Namestring

Name of the module item draft.

UrlSlugstring

URL-friendly identifier.

ParentIdinteger

Identifier of the direct parent item.

Enabledboolean

Indicates whether the item is active and visible in the system.

ReleaseDatestring · date-time

Date and time when the item becomes publicly available.

ExpiryDatestring · date-time

Date and time when the item expires and is no longer available.

Descriptionstring · nullable

Textual description of the item.

Weightinginteger

Numeric priority value used for ordering or ranking items.

DisableForSiteSearchboolean

Specifies whether the item should be excluded from the site search index.

SKUCodestring · nullable

Stock Keeping Unit identifier.

CreatedByMemberIdinteger

Identifier of the member who created the item.

Authorinteger

IIdentifier of the author associated with the item.

ModuleIdinteger

Identifier of the related module.

TemplateIdinteger

Identifier of the template used to render the item.

LayoutIdinteger

Identifier of the layout applied to the item.

Parentsarray of integers

Array (integer)- an array of parent category/element IDs.

ItemCategoriesarray of strings

Array (string)- list of category identifiers or names assigned to the item.

ItemTagsarray of strings

Array (string)- list of tags associated with the item for classification and filtering.

SiteSearchKeywordsarray of strings

Additional keywords used to improve search relevance for this item.

CustomPropertiesobject · nullable

An object containing additional attributes specific to a given content type.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-items/draft/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"EventProperties":{"HideWhenFull":false,"AllowMultipleSubscriptionPerEmail":false,"Capacity":0,"EventDateStart":"2026-07-01T00:00:00Z","EventDateEnd":"2026-07-01T00:00:00Z"},"ProductProperties":{"SmallImage":"string","LargeImage":"string","OnSale":false,"IsGiftVoucher":false,"ProductWeight":10,"ProductWidth":0,"ProductHeight":0,"ProductDepth":0,"EnableDropShipping":false,"UnitType":"string","MinimumUnits":0,"MaximumUnits":0,"RecurringType":"None","IsShippable":false,"IsDownloadable":false,"NumberOfPossibleDownloads":0,"Supplier":0,"IsHide":false,"InStock":0,"IsDisable":false,"IsGroupedProduct":false,"DownloadableFileLink":"string"},"Name":"Example","UrlSlug":"https://example.com","ParentId":1,"Enabled":false,"ReleaseDate":"2026-07-01T00:00:00Z","ExpiryDate":"2026-07-01T00:00:00Z","Description":"string","Weighting":10,"DisableForSiteSearch":false,"SKUCode":"string","CreatedByMemberId":1,"Author":0,"ModuleId":1,"TemplateId":1,"LayoutId":1,"Parents":[0],"ItemCategories":["string"],"ItemTags":["string"],"SiteSearchKeywords":["string"],"CustomProperties":{}}'

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/draft/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "EventProperties": {
      "HideWhenFull": false,
      "AllowMultipleSubscriptionPerEmail": false,
      "Capacity": 0,
      "EventDateStart": "2026-07-01T00:00:00Z",
      "EventDateEnd": "2026-07-01T00:00:00Z"
    },
    "ProductProperties": {
      "SmallImage": "string",
      "LargeImage": "string",
      "OnSale": false,
      "IsGiftVoucher": false,
      "ProductWeight": 10,
      "ProductWidth": 0,
      "ProductHeight": 0,
      "ProductDepth": 0,
      "EnableDropShipping": false,
      "UnitType": "string",
      "MinimumUnits": 0,
      "MaximumUnits": 0,
      "RecurringType": "None",
      "IsShippable": false,
      "IsDownloadable": false,
      "NumberOfPossibleDownloads": 0,
      "Supplier": 0,
      "IsHide": false,
      "InStock": 0,
      "IsDisable": false,
      "IsGroupedProduct": false,
      "DownloadableFileLink": "string"
    },
    "Name": "Example",
    "UrlSlug": "https://example.com",
    "ParentId": 1,
    "Enabled": false,
    "ReleaseDate": "2026-07-01T00:00:00Z",
    "ExpiryDate": "2026-07-01T00:00:00Z",
    "Description": "string",
    "Weighting": 10,
    "DisableForSiteSearch": false,
    "SKUCode": "string",
    "CreatedByMemberId": 1,
    "Author": 0,
    "ModuleId": 1,
    "TemplateId": 1,
    "LayoutId": 1,
    "Parents": [
      0
    ],
    "ItemCategories": [
      "string"
    ],
    "ItemTags": [
      "string"
    ],
    "SiteSearchKeywords": [
      "string"
    ],
    "CustomProperties": {}
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/module-items/draft/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "EventProperties": {
            "HideWhenFull": False,
            "AllowMultipleSubscriptionPerEmail": False,
            "Capacity": 0,
            "EventDateStart": "2026-07-01T00:00:00Z",
            "EventDateEnd": "2026-07-01T00:00:00Z"
        },
        "ProductProperties": {
            "SmallImage": "string",
            "LargeImage": "string",
            "OnSale": False,
            "IsGiftVoucher": False,
            "ProductWeight": 10,
            "ProductWidth": 0,
            "ProductHeight": 0,
            "ProductDepth": 0,
            "EnableDropShipping": False,
            "UnitType": "string",
            "MinimumUnits": 0,
            "MaximumUnits": 0,
            "RecurringType": "None",
            "IsShippable": False,
            "IsDownloadable": False,
            "NumberOfPossibleDownloads": 0,
            "Supplier": 0,
            "IsHide": False,
            "InStock": 0,
            "IsDisable": False,
            "IsGroupedProduct": False,
            "DownloadableFileLink": "string"
        },
        "Name": "Example",
        "UrlSlug": "https://example.com",
        "ParentId": 1,
        "Enabled": False,
        "ReleaseDate": "2026-07-01T00:00:00Z",
        "ExpiryDate": "2026-07-01T00:00:00Z",
        "Description": "string",
        "Weighting": 10,
        "DisableForSiteSearch": False,
        "SKUCode": "string",
        "CreatedByMemberId": 1,
        "Author": 0,
        "ModuleId": 1,
        "TemplateId": 1,
        "LayoutId": 1,
        "Parents": [0],
        "ItemCategories": ["string"],
        "ItemTags": ["string"],
        "SiteSearchKeywords": ["string"],
        "CustomProperties": {

        }
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/module-items/draft/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'EventProperties' => [
            'HideWhenFull' => false,
            'AllowMultipleSubscriptionPerEmail' => false,
            'Capacity' => 0,
            'EventDateStart' => '2026-07-01T00:00:00Z',
            'EventDateEnd' => '2026-07-01T00:00:00Z'
        ],
        'ProductProperties' => [
            'SmallImage' => 'string',
            'LargeImage' => 'string',
            'OnSale' => false,
            'IsGiftVoucher' => false,
            'ProductWeight' => 10,
            'ProductWidth' => 0,
            'ProductHeight' => 0,
            'ProductDepth' => 0,
            'EnableDropShipping' => false,
            'UnitType' => 'string',
            'MinimumUnits' => 0,
            'MaximumUnits' => 0,
            'RecurringType' => 'None',
            'IsShippable' => false,
            'IsDownloadable' => false,
            'NumberOfPossibleDownloads' => 0,
            'Supplier' => 0,
            'IsHide' => false,
            'InStock' => 0,
            'IsDisable' => false,
            'IsGroupedProduct' => false,
            'DownloadableFileLink' => 'string'
        ],
        'Name' => 'Example',
        'UrlSlug' => 'https://example.com',
        'ParentId' => 1,
        'Enabled' => false,
        'ReleaseDate' => '2026-07-01T00:00:00Z',
        'ExpiryDate' => '2026-07-01T00:00:00Z',
        'Description' => 'string',
        'Weighting' => 10,
        'DisableForSiteSearch' => false,
        'SKUCode' => 'string',
        'CreatedByMemberId' => 1,
        'Author' => 0,
        'ModuleId' => 1,
        'TemplateId' => 1,
        'LayoutId' => 1,
        'Parents' => [0],
        'ItemCategories' => ['string'],
        'ItemTags' => ['string'],
        'SiteSearchKeywords' => ['string'],
        'CustomProperties' => [

        ]
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/module-items/draft/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"EventProperties\":{\"HideWhenFull\":false,\"AllowMultipleSubscriptionPerEmail\":false,\"Capacity\":0,\"EventDateStart\":\"2026-07-01T00:00:00Z\",\"EventDateEnd\":\"2026-07-01T00:00:00Z\"},\"ProductProperties\":{\"SmallImage\":\"string\",\"LargeImage\":\"string\",\"OnSale\":false,\"IsGiftVoucher\":false,\"ProductWeight\":10,\"ProductWidth\":0,\"ProductHeight\":0,\"ProductDepth\":0,\"EnableDropShipping\":false,\"UnitType\":\"string\",\"MinimumUnits\":0,\"MaximumUnits\":0,\"RecurringType\":\"None\",\"IsShippable\":false,\"IsDownloadable\":false,\"NumberOfPossibleDownloads\":0,\"Supplier\":0,\"IsHide\":false,\"InStock\":0,\"IsDisable\":false,\"IsGroupedProduct\":false,\"DownloadableFileLink\":\"string\"},\"Name\":\"Example\",\"UrlSlug\":\"https://example.com\",\"ParentId\":1,\"Enabled\":false,\"ReleaseDate\":\"2026-07-01T00:00:00Z\",\"ExpiryDate\":\"2026-07-01T00:00:00Z\",\"Description\":\"string\",\"Weighting\":10,\"DisableForSiteSearch\":false,\"SKUCode\":\"string\",\"CreatedByMemberId\":1,\"Author\":0,\"ModuleId\":1,\"TemplateId\":1,\"LayoutId\":1,\"Parents\":[0],\"ItemCategories\":[\"string\"],\"ItemTags\":[\"string\"],\"SiteSearchKeywords\":[\"string\"],\"CustomProperties\":{}}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "Url": "https://example.com",
  "ItemRating": 0,
  "UrlList": [
    "string"
  ],
  "LastUpdatedDate": "2026-07-01T00: 00: 00Z",
  "ItemCategoriesIdList": [
    0
  ],
  "SiteSearchKeywordsString": "string",
  "IsActiveDraft": false,
  "EventProperties": {
    "HideWhenFull": false,
    "AllowMultipleSubscriptionPerEmail": false,
    "Capacity": 0,
    "Allocation": 0,
    "EventDateStart": "2026-07-01T00: 00: 00Z",
    "EventDateEnd": "2026-07-01T00: 00: 00Z"
  },
  "ProductProperties": {
    "SmallImage": "string",
    "LargeImage": "string",
    "OnSale": false,
    "IsGiftVoucher": false,
    "ProductWeight": 10,
    "ProductWidth": 0,
    "ProductHeight": 0,
    "ProductDepth": 0,
    "EnableDropShipping": false,
    "UnitType": "string",
    "MinimumUnits": 0,
    "MaximumUnits": 0,
    "RecurringType": "None",
    "IsShippable": false,
    "IsDownloadable": false,
    "NumberOfPossibleDownloads": 0,
    "Supplier": 0,
    "IsHide": false,
    "InStock": 0,
    "IsDisable": false,
    "IsGroupedProduct": false,
    "DownloadableFileLink": "string"
  },
  "ParentName": "Example",
  "ParentUrl": "https://example.com",
  "Name": "Example",
  "UrlSlug": "https://example.com",
  "ParentId": 1,
  "Enabled": false,
  "ReleaseDate": "2026-07-01T00: 00: 00Z",
  "ExpiryDate": "2026-07-01T00: 00: 00Z",
  "Description": "string",
  "Weighting": 10,
  "DisableForSiteSearch": false,
  "SKUCode": "string",
  "CreatedByMemberId": 1,
  "Author": 0,
  "ModuleId": 1,
  "TemplateId": 1,
  "LayoutId": 1,
  "Parents": [
    0
  ],
  "ItemCategories": [
    "string"
  ],
  "ItemTags": [
    "string"
  ],
  "SiteSearchKeywords": [
    "string"
  ],
  "CustomProperties": {}
}

DELETE/api/v2/admin/module-items/draft/{id}#

Deletes an existing module item draft

Parameters

idinteger · pathrequired

Resource identifier.

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

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

import requests

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

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

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

PUT/api/v2/admin/module-items/publish-draft/{id}#

Publish a module item draft

Parameters

idinteger · pathrequired

Resource identifier.

Body parameters

EventPropertiesobject

Event-specific settings (dates, capacity, booking rules) applied when the item represents an event.

ProductPropertiesobject

Product-specific settings (pricing, stock, dimensions, shipping) applied when the item represents a product.

SmallImagestring · nullable

Path to the product's small (thumbnail) image.

LargeImagestring · nullable

Path to the product's large (full-size) image.

OnSaleboolean

When enabled, the product is marked as being on sale.

IsGiftVoucherboolean

When enabled, the product is treated as a gift voucher rather than a physical or digital good.

ProductWeightnumber

Physical weight of the product, used for shipping calculations.

ProductWidthnumber

Physical width of the product, used for shipping and packaging.

ProductHeightnumber

Physical height of the product, used for shipping and packaging.

ProductDepthnumber

Physical depth of the product, used for shipping and packaging.

EnableDropShippingboolean

Whether enable drop shipping is on.

UnitTypestring · nullable

Label for the unit in which the product is sold (for example, piece, kg, box).

MinimumUnitsinteger

Smallest quantity a customer may order in a single purchase.

MaximumUnitsinteger

Largest quantity a customer may order in a single purchase.

RecurringTypeenum

IsShippableboolean

When enabled, the product requires shipping and shipping options are applied at checkout.

IsDownloadableboolean

When enabled, the product delivers a downloadable file after purchase.

NumberOfPossibleDownloadsinteger

How many times a buyer may download the file after purchasing a downloadable product.

Supplierinteger

Identifier of the supplier associated with this product.

IsHideboolean

When enabled, the product is hidden from the storefront.

InStockinteger

Current number of units available in stock.

IsDisableboolean

When enabled, the product is disabled and cannot be ordered.

IsGroupedProductboolean

When enabled, the product is a grouped product that bundles other products together.

DownloadableFileLinkstring · nullable

Path or link to the file delivered when the product is downloadable.

Namestringrequired

Name of the module item request update.

UrlSlugstringrequired

URL-friendly identifier.

ParentIdinteger

Identifier of the direct parent item.

Enabledboolean

Indicates whether the item is active and visible in the system. By default - true.

ReleaseDatestring · date-time

Date and time when the item becomes publicly available.

ExpiryDatestring · date-time

Date and time when the item expires and is no longer available.

Descriptionstring · nullable

Textual description of the item.

Weightinginteger

Numeric priority value used for ordering or ranking items.

DisableForSiteSearchboolean

Specifies whether the item should be excluded from the site search index. By default - true.

SKUCodestring · nullable

Stock Keeping Unit identifier.

CreatedByMemberIdinteger

Identifier of the member who created the item.

Authorinteger

IIdentifier of the author associated with the item.

ModuleIdintegerrequired

Identifier of the related module.

TemplateIdinteger

Identifier of the template used to render the item.

LayoutIdinteger

Identifier of the layout applied to the item.

Parentsarray of integers

Array (integer) - an array of parent category/element IDs.

ItemCategoriesarray of strings

Array (string)- list of category identifiers or names assigned to the item.

ItemTagsarray of strings

Array (string)- list of tags associated with the item for classification and filtering.

SiteSearchKeywordsarray of strings

Additional keywords used to improve search relevance for this item.

CustomPropertiesobject · nullable

An object containing additional attributes specific to a given content type.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

Urlstring · nullable

URL-friendly identifier.

ItemRatinginteger

Average rating of the object.

UrlListarray of strings

A list of relative URLs (slugs) that lead to detailed pages or resources for specific module elements.

LastUpdatedDatestring · date-time

The date and time the object was last updated. Read-only.

ItemCategoriesIdListarray of integers

A list of unique identifiers (IDs) of the categories to which this item belongs.

SiteSearchKeywordsStringstring · nullable

Additional keywords for this draft item, joined into a single comma-separated string, used to improve internal site search relevance.

IsActiveDraftboolean

A flag indicating the current draft status of the object.

EventPropertiesobject

An object that contains additional metadata or specific properties associated with an event.

ProductPropertiesobject

Product Features Collection.

SmallImagestring · nullable

Path to the product's small (thumbnail) image.

LargeImagestring · nullable

Path to the product's large (full-size) image.

OnSaleboolean

When enabled, the product is marked as being on sale.

IsGiftVoucherboolean

When enabled, the product is treated as a gift voucher rather than a physical or digital good.

ProductWeightnumber

Physical weight of the product, used for shipping calculations.

ProductWidthnumber

Physical width of the product, used for shipping and packaging.

ProductHeightnumber

Physical height of the product, used for shipping and packaging.

ProductDepthnumber

Physical depth of the product, used for shipping and packaging.

EnableDropShippingboolean

Whether enable drop shipping is on.

UnitTypestring · nullable

Label for the unit in which the product is sold (for example, piece, kg, box).

MinimumUnitsinteger

Smallest quantity a customer may order in a single purchase.

MaximumUnitsinteger

Largest quantity a customer may order in a single purchase.

RecurringTypeenum

IsShippableboolean

When enabled, the product requires shipping and shipping options are applied at checkout.

IsDownloadableboolean

When enabled, the product delivers a downloadable file after purchase.

NumberOfPossibleDownloadsinteger

How many times a buyer may download the file after purchasing a downloadable product.

Supplierinteger

Identifier of the supplier associated with this product.

IsHideboolean

When enabled, the product is hidden from the storefront.

InStockinteger

Current number of units available in stock.

IsDisableboolean

When enabled, the product is disabled and cannot be ordered.

IsGroupedProductboolean

When enabled, the product is a grouped product that bundles other products together.

DownloadableFileLinkstring · nullable

Path or link to the file delivered when the product is downloadable.

ParentNamestring · nullable

Parent object or category name.

ParentUrlstring · nullable

Relative or absolute URL path to the parent object's page.

Namestring

Name of the module item draft.

UrlSlugstring

URL-friendly identifier.

ParentIdinteger

Identifier of the direct parent item.

Enabledboolean

Indicates whether the item is active and visible in the system.

ReleaseDatestring · date-time

Date and time when the item becomes publicly available.

ExpiryDatestring · date-time

Date and time when the item expires and is no longer available.

Descriptionstring · nullable

Textual description of the item.

Weightinginteger

Numeric priority value used for ordering or ranking items.

DisableForSiteSearchboolean

Specifies whether the item should be excluded from the site search index.

SKUCodestring · nullable

Stock Keeping Unit identifier.

CreatedByMemberIdinteger

Identifier of the member who created the item.

Authorinteger

IIdentifier of the author associated with the item.

ModuleIdinteger

Identifier of the related module.

TemplateIdinteger

Identifier of the template used to render the item.

LayoutIdinteger

Identifier of the layout applied to the item.

Parentsarray of integers

Array (integer)- an array of parent category/element IDs.

ItemCategoriesarray of strings

Array (string)- list of category identifiers or names assigned to the item.

ItemTagsarray of strings

Array (string)- list of tags associated with the item for classification and filtering.

SiteSearchKeywordsarray of strings

Additional keywords used to improve search relevance for this item.

CustomPropertiesobject · nullable

An object containing additional attributes specific to a given content type.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-items/publish-draft/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"EventProperties":{"HideWhenFull":false,"AllowMultipleSubscriptionPerEmail":false,"Capacity":0,"EventDateStart":"2026-07-01T00:00:00Z","EventDateEnd":"2026-07-01T00:00:00Z"},"ProductProperties":{"SmallImage":"string","LargeImage":"string","OnSale":false,"IsGiftVoucher":false,"ProductWeight":10,"ProductWidth":0,"ProductHeight":0,"ProductDepth":0,"EnableDropShipping":false,"UnitType":"string","MinimumUnits":0,"MaximumUnits":0,"RecurringType":"None","IsShippable":false,"IsDownloadable":false,"NumberOfPossibleDownloads":0,"Supplier":0,"IsHide":false,"InStock":0,"IsDisable":false,"IsGroupedProduct":false,"DownloadableFileLink":"string"},"Name":"Example","UrlSlug":"https://example.com","ParentId":1,"Enabled":false,"ReleaseDate":"2026-07-01T00:00:00Z","ExpiryDate":"2026-07-01T00:00:00Z","Description":"string","Weighting":10,"DisableForSiteSearch":false,"SKUCode":"string","CreatedByMemberId":1,"Author":0,"ModuleId":1,"TemplateId":1,"LayoutId":1,"Parents":[0],"ItemCategories":["string"],"ItemTags":["string"],"SiteSearchKeywords":["string"],"CustomProperties":{}}'

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/publish-draft/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "EventProperties": {
      "HideWhenFull": false,
      "AllowMultipleSubscriptionPerEmail": false,
      "Capacity": 0,
      "EventDateStart": "2026-07-01T00:00:00Z",
      "EventDateEnd": "2026-07-01T00:00:00Z"
    },
    "ProductProperties": {
      "SmallImage": "string",
      "LargeImage": "string",
      "OnSale": false,
      "IsGiftVoucher": false,
      "ProductWeight": 10,
      "ProductWidth": 0,
      "ProductHeight": 0,
      "ProductDepth": 0,
      "EnableDropShipping": false,
      "UnitType": "string",
      "MinimumUnits": 0,
      "MaximumUnits": 0,
      "RecurringType": "None",
      "IsShippable": false,
      "IsDownloadable": false,
      "NumberOfPossibleDownloads": 0,
      "Supplier": 0,
      "IsHide": false,
      "InStock": 0,
      "IsDisable": false,
      "IsGroupedProduct": false,
      "DownloadableFileLink": "string"
    },
    "Name": "Example",
    "UrlSlug": "https://example.com",
    "ParentId": 1,
    "Enabled": false,
    "ReleaseDate": "2026-07-01T00:00:00Z",
    "ExpiryDate": "2026-07-01T00:00:00Z",
    "Description": "string",
    "Weighting": 10,
    "DisableForSiteSearch": false,
    "SKUCode": "string",
    "CreatedByMemberId": 1,
    "Author": 0,
    "ModuleId": 1,
    "TemplateId": 1,
    "LayoutId": 1,
    "Parents": [
      0
    ],
    "ItemCategories": [
      "string"
    ],
    "ItemTags": [
      "string"
    ],
    "SiteSearchKeywords": [
      "string"
    ],
    "CustomProperties": {}
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/module-items/publish-draft/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "EventProperties": {
            "HideWhenFull": False,
            "AllowMultipleSubscriptionPerEmail": False,
            "Capacity": 0,
            "EventDateStart": "2026-07-01T00:00:00Z",
            "EventDateEnd": "2026-07-01T00:00:00Z"
        },
        "ProductProperties": {
            "SmallImage": "string",
            "LargeImage": "string",
            "OnSale": False,
            "IsGiftVoucher": False,
            "ProductWeight": 10,
            "ProductWidth": 0,
            "ProductHeight": 0,
            "ProductDepth": 0,
            "EnableDropShipping": False,
            "UnitType": "string",
            "MinimumUnits": 0,
            "MaximumUnits": 0,
            "RecurringType": "None",
            "IsShippable": False,
            "IsDownloadable": False,
            "NumberOfPossibleDownloads": 0,
            "Supplier": 0,
            "IsHide": False,
            "InStock": 0,
            "IsDisable": False,
            "IsGroupedProduct": False,
            "DownloadableFileLink": "string"
        },
        "Name": "Example",
        "UrlSlug": "https://example.com",
        "ParentId": 1,
        "Enabled": False,
        "ReleaseDate": "2026-07-01T00:00:00Z",
        "ExpiryDate": "2026-07-01T00:00:00Z",
        "Description": "string",
        "Weighting": 10,
        "DisableForSiteSearch": False,
        "SKUCode": "string",
        "CreatedByMemberId": 1,
        "Author": 0,
        "ModuleId": 1,
        "TemplateId": 1,
        "LayoutId": 1,
        "Parents": [0],
        "ItemCategories": ["string"],
        "ItemTags": ["string"],
        "SiteSearchKeywords": ["string"],
        "CustomProperties": {

        }
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/module-items/publish-draft/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'EventProperties' => [
            'HideWhenFull' => false,
            'AllowMultipleSubscriptionPerEmail' => false,
            'Capacity' => 0,
            'EventDateStart' => '2026-07-01T00:00:00Z',
            'EventDateEnd' => '2026-07-01T00:00:00Z'
        ],
        'ProductProperties' => [
            'SmallImage' => 'string',
            'LargeImage' => 'string',
            'OnSale' => false,
            'IsGiftVoucher' => false,
            'ProductWeight' => 10,
            'ProductWidth' => 0,
            'ProductHeight' => 0,
            'ProductDepth' => 0,
            'EnableDropShipping' => false,
            'UnitType' => 'string',
            'MinimumUnits' => 0,
            'MaximumUnits' => 0,
            'RecurringType' => 'None',
            'IsShippable' => false,
            'IsDownloadable' => false,
            'NumberOfPossibleDownloads' => 0,
            'Supplier' => 0,
            'IsHide' => false,
            'InStock' => 0,
            'IsDisable' => false,
            'IsGroupedProduct' => false,
            'DownloadableFileLink' => 'string'
        ],
        'Name' => 'Example',
        'UrlSlug' => 'https://example.com',
        'ParentId' => 1,
        'Enabled' => false,
        'ReleaseDate' => '2026-07-01T00:00:00Z',
        'ExpiryDate' => '2026-07-01T00:00:00Z',
        'Description' => 'string',
        'Weighting' => 10,
        'DisableForSiteSearch' => false,
        'SKUCode' => 'string',
        'CreatedByMemberId' => 1,
        'Author' => 0,
        'ModuleId' => 1,
        'TemplateId' => 1,
        'LayoutId' => 1,
        'Parents' => [0],
        'ItemCategories' => ['string'],
        'ItemTags' => ['string'],
        'SiteSearchKeywords' => ['string'],
        'CustomProperties' => [

        ]
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/module-items/publish-draft/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"EventProperties\":{\"HideWhenFull\":false,\"AllowMultipleSubscriptionPerEmail\":false,\"Capacity\":0,\"EventDateStart\":\"2026-07-01T00:00:00Z\",\"EventDateEnd\":\"2026-07-01T00:00:00Z\"},\"ProductProperties\":{\"SmallImage\":\"string\",\"LargeImage\":\"string\",\"OnSale\":false,\"IsGiftVoucher\":false,\"ProductWeight\":10,\"ProductWidth\":0,\"ProductHeight\":0,\"ProductDepth\":0,\"EnableDropShipping\":false,\"UnitType\":\"string\",\"MinimumUnits\":0,\"MaximumUnits\":0,\"RecurringType\":\"None\",\"IsShippable\":false,\"IsDownloadable\":false,\"NumberOfPossibleDownloads\":0,\"Supplier\":0,\"IsHide\":false,\"InStock\":0,\"IsDisable\":false,\"IsGroupedProduct\":false,\"DownloadableFileLink\":\"string\"},\"Name\":\"Example\",\"UrlSlug\":\"https://example.com\",\"ParentId\":1,\"Enabled\":false,\"ReleaseDate\":\"2026-07-01T00:00:00Z\",\"ExpiryDate\":\"2026-07-01T00:00:00Z\",\"Description\":\"string\",\"Weighting\":10,\"DisableForSiteSearch\":false,\"SKUCode\":\"string\",\"CreatedByMemberId\":1,\"Author\":0,\"ModuleId\":1,\"TemplateId\":1,\"LayoutId\":1,\"Parents\":[0],\"ItemCategories\":[\"string\"],\"ItemTags\":[\"string\"],\"SiteSearchKeywords\":[\"string\"],\"CustomProperties\":{}}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "Url": "https://example.com",
  "ItemRating": 0,
  "UrlList": [
    "string"
  ],
  "LastUpdatedDate": "2026-07-01T00: 00: 00Z",
  "ItemCategoriesIdList": [
    0
  ],
  "SiteSearchKeywordsString": "string",
  "IsActiveDraft": false,
  "EventProperties": {
    "HideWhenFull": false,
    "AllowMultipleSubscriptionPerEmail": false,
    "Capacity": 0,
    "Allocation": 0,
    "EventDateStart": "2026-07-01T00: 00: 00Z",
    "EventDateEnd": "2026-07-01T00: 00: 00Z"
  },
  "ProductProperties": {
    "SmallImage": "string",
    "LargeImage": "string",
    "OnSale": false,
    "IsGiftVoucher": false,
    "ProductWeight": 10,
    "ProductWidth": 0,
    "ProductHeight": 0,
    "ProductDepth": 0,
    "EnableDropShipping": false,
    "UnitType": "string",
    "MinimumUnits": 0,
    "MaximumUnits": 0,
    "RecurringType": "None",
    "IsShippable": false,
    "IsDownloadable": false,
    "NumberOfPossibleDownloads": 0,
    "Supplier": 0,
    "IsHide": false,
    "InStock": 0,
    "IsDisable": false,
    "IsGroupedProduct": false,
    "DownloadableFileLink": "string"
  },
  "ParentName": "Example",
  "ParentUrl": "https://example.com",
  "Name": "Example",
  "UrlSlug": "https://example.com",
  "ParentId": 1,
  "Enabled": false,
  "ReleaseDate": "2026-07-01T00: 00: 00Z",
  "ExpiryDate": "2026-07-01T00: 00: 00Z",
  "Description": "string",
  "Weighting": 10,
  "DisableForSiteSearch": false,
  "SKUCode": "string",
  "CreatedByMemberId": 1,
  "Author": 0,
  "ModuleId": 1,
  "TemplateId": 1,
  "LayoutId": 1,
  "Parents": [
    0
  ],
  "ItemCategories": [
    "string"
  ],
  "ItemTags": [
    "string"
  ],
  "SiteSearchKeywords": [
    "string"
  ],
  "CustomProperties": {}
}

GET/api/v2/admin/module-items/seo/draft/{id}#

Retrieve a module item SEO draft

Parameters

idinteger · pathrequired

Resource identifier.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

SEOTitlestring · nullable

Title used in the page's SEO metadata and shown in search-engine results.

MetaDescriptionstring · nullable

Meta description shown in search-engine result snippets for the item's page.

CanonicalLinkstring · nullable

Canonical URL that tells search engines the preferred address for this page, avoiding duplicate-content issues.

SocialMetaTagsstring · nullable

Social meta tags (such as Open Graph or Twitter Card markup) used when the item's page is shared on social networks.

SeoPrioritynumber

Priority value for this page in the generated sitemap, hinting its relative importance to search engines.

EnableAMPboolean

Whether enable amp is on.

AMPContentstring · nullable

Accelerated Mobile Pages (AMP) HTML content served for this item's page.

ShowPageForSearchEngineboolean

Show page for search engine.

OpenGraphPropertiesobject

Open Graph properties (title, type, image, locale, URL) that control how the page appears when shared on social networks.

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

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

import requests

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

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

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

Response · 200

{
  "Id": 1,
  "SEOTitle": "string",
  "MetaDescription": "string",
  "CanonicalLink": "string",
  "SocialMetaTags": "string",
  "SeoPriority": 0,
  "EnableAMP": false,
  "AMPContent": "string",
  "ShowPageForSearchEngine": false,
  "OpenGraphProperties": {
    "Image": "string",
    "Locale": "string",
    "Title": "string",
    "Type": "string",
    "Url": "https://example.com"
  }
}

PUT/api/v2/admin/module-items/seo/draft/{id}#

Update a module item SEO draft

Parameters

idinteger · pathrequired

Resource identifier.

Body parameters

SEOTitlestring · nullable

Title used in the page's SEO metadata and shown in search-engine results.

MetaDescriptionstring · nullable

Meta description shown in search-engine result snippets for the item's page.

CanonicalLinkstring · nullable

Canonical URL that tells search engines the preferred address for this page, avoiding duplicate-content issues.

SocialMetaTagsstring · nullable

Social meta tags (such as Open Graph or Twitter Card markup) used when the item's page is shared on social networks.

SeoPrioritynumber

Priority value for this page in the generated sitemap, hinting its relative importance to search engines.

EnableAMPboolean

Whether enable amp is on.

AMPContentstring · nullable

Accelerated Mobile Pages (AMP) HTML content served for this item's page.

ShowPageForSearchEngineboolean

Show page for search engine.

OpenGraphPropertiesobject

Open Graph properties (title, type, image, locale, URL) that control how the page appears when shared on social networks.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

SEOTitlestring · nullable

Title used in the page's SEO metadata and shown in search-engine results.

MetaDescriptionstring · nullable

Meta description shown in search-engine result snippets for the item's page.

CanonicalLinkstring · nullable

Canonical URL that tells search engines the preferred address for this page, avoiding duplicate-content issues.

SocialMetaTagsstring · nullable

Social meta tags (such as Open Graph or Twitter Card markup) used when the item's page is shared on social networks.

SeoPrioritynumber

Priority value for this page in the generated sitemap, hinting its relative importance to search engines.

EnableAMPboolean

Whether enable amp is on.

AMPContentstring · nullable

Accelerated Mobile Pages (AMP) HTML content served for this item's page.

ShowPageForSearchEngineboolean

Show page for search engine.

OpenGraphPropertiesobject

Open Graph properties (title, type, image, locale, URL) that control how the page appears when shared on social networks.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-items/seo/draft/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"SEOTitle":"string","MetaDescription":"string","CanonicalLink":"string","SocialMetaTags":"string","SeoPriority":0,"EnableAMP":false,"AMPContent":"string","ShowPageForSearchEngine":false,"OpenGraphProperties":{"Image":"string","Locale":"string","Title":"string","Type":"string","Url":"https://example.com"}}'

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/seo/draft/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "SEOTitle": "string",
    "MetaDescription": "string",
    "CanonicalLink": "string",
    "SocialMetaTags": "string",
    "SeoPriority": 0,
    "EnableAMP": false,
    "AMPContent": "string",
    "ShowPageForSearchEngine": false,
    "OpenGraphProperties": {
      "Image": "string",
      "Locale": "string",
      "Title": "string",
      "Type": "string",
      "Url": "https://example.com"
    }
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/module-items/seo/draft/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "SEOTitle": "string",
        "MetaDescription": "string",
        "CanonicalLink": "string",
        "SocialMetaTags": "string",
        "SeoPriority": 0,
        "EnableAMP": False,
        "AMPContent": "string",
        "ShowPageForSearchEngine": False,
        "OpenGraphProperties": {
            "Image": "string",
            "Locale": "string",
            "Title": "string",
            "Type": "string",
            "Url": "https://example.com"
        }
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/module-items/seo/draft/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'SEOTitle' => 'string',
        'MetaDescription' => 'string',
        'CanonicalLink' => 'string',
        'SocialMetaTags' => 'string',
        'SeoPriority' => 0,
        'EnableAMP' => false,
        'AMPContent' => 'string',
        'ShowPageForSearchEngine' => false,
        'OpenGraphProperties' => [
            'Image' => 'string',
            'Locale' => 'string',
            'Title' => 'string',
            'Type' => 'string',
            'Url' => 'https://example.com'
        ]
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/module-items/seo/draft/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"SEOTitle\":\"string\",\"MetaDescription\":\"string\",\"CanonicalLink\":\"string\",\"SocialMetaTags\":\"string\",\"SeoPriority\":0,\"EnableAMP\":false,\"AMPContent\":\"string\",\"ShowPageForSearchEngine\":false,\"OpenGraphProperties\":{\"Image\":\"string\",\"Locale\":\"string\",\"Title\":\"string\",\"Type\":\"string\",\"Url\":\"https://example.com\"}}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "SEOTitle": "string",
  "MetaDescription": "string",
  "CanonicalLink": "string",
  "SocialMetaTags": "string",
  "SeoPriority": 0,
  "EnableAMP": false,
  "AMPContent": "string",
  "ShowPageForSearchEngine": false,
  "OpenGraphProperties": {
    "Image": "string",
    "Locale": "string",
    "Title": "string",
    "Type": "string",
    "Url": "https://example.com"
  }
}

DELETE/api/v2/admin/module-items/seo/draft/{id}#

Delete a module item SEO draft

Parameters

idinteger · pathrequired

Resource identifier.

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

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

import requests

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

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

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

PUT/api/v2/admin/module-items/seo/publish-draft/{id}#

Publish a module item SEO draft

Parameters

idinteger · pathrequired

Resource identifier.

Body parameters

SEOTitlestring · nullable

Title used in the page's SEO metadata and shown in search-engine results.

MetaDescriptionstring · nullable

Meta description shown in search-engine result snippets for the item's page.

CanonicalLinkstring · nullable

Canonical URL that tells search engines the preferred address for this page, avoiding duplicate-content issues.

SocialMetaTagsstring · nullable

Social meta tags (such as Open Graph or Twitter Card markup) used when the item's page is shared on social networks.

SeoPrioritynumber

Priority value for this page in the generated sitemap, hinting its relative importance to search engines.

EnableAMPboolean

Whether enable amp is on.

AMPContentstring · nullable

Accelerated Mobile Pages (AMP) HTML content served for this item's page.

ShowPageForSearchEngineboolean

Show page for search engine.

OpenGraphPropertiesobject

Open Graph properties (title, type, image, locale, URL) that control how the page appears when shared on social networks.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

SEOTitlestring · nullable

Title used in the page's SEO metadata and shown in search-engine results.

MetaDescriptionstring · nullable

Meta description shown in search-engine result snippets for the item's page.

CanonicalLinkstring · nullable

Canonical URL that tells search engines the preferred address for this page, avoiding duplicate-content issues.

SocialMetaTagsstring · nullable

Social meta tags (such as Open Graph or Twitter Card markup) used when the item's page is shared on social networks.

SeoPrioritynumber

Priority value for this page in the generated sitemap, hinting its relative importance to search engines.

EnableAMPboolean

Whether enable amp is on.

AMPContentstring · nullable

Accelerated Mobile Pages (AMP) HTML content served for this item's page.

ShowPageForSearchEngineboolean

Show page for search engine.

OpenGraphPropertiesobject

Open Graph properties (title, type, image, locale, URL) that control how the page appears when shared on social networks.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-items/seo/publish-draft/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"SEOTitle":"string","MetaDescription":"string","CanonicalLink":"string","SocialMetaTags":"string","SeoPriority":0,"EnableAMP":false,"AMPContent":"string","ShowPageForSearchEngine":false,"OpenGraphProperties":{"Image":"string","Locale":"string","Title":"string","Type":"string","Url":"https://example.com"}}'

await fetch("https://your-site.webinone.com/api/v2/admin/module-items/seo/publish-draft/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "SEOTitle": "string",
    "MetaDescription": "string",
    "CanonicalLink": "string",
    "SocialMetaTags": "string",
    "SeoPriority": 0,
    "EnableAMP": false,
    "AMPContent": "string",
    "ShowPageForSearchEngine": false,
    "OpenGraphProperties": {
      "Image": "string",
      "Locale": "string",
      "Title": "string",
      "Type": "string",
      "Url": "https://example.com"
    }
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/module-items/seo/publish-draft/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "SEOTitle": "string",
        "MetaDescription": "string",
        "CanonicalLink": "string",
        "SocialMetaTags": "string",
        "SeoPriority": 0,
        "EnableAMP": False,
        "AMPContent": "string",
        "ShowPageForSearchEngine": False,
        "OpenGraphProperties": {
            "Image": "string",
            "Locale": "string",
            "Title": "string",
            "Type": "string",
            "Url": "https://example.com"
        }
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/module-items/seo/publish-draft/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'SEOTitle' => 'string',
        'MetaDescription' => 'string',
        'CanonicalLink' => 'string',
        'SocialMetaTags' => 'string',
        'SeoPriority' => 0,
        'EnableAMP' => false,
        'AMPContent' => 'string',
        'ShowPageForSearchEngine' => false,
        'OpenGraphProperties' => [
            'Image' => 'string',
            'Locale' => 'string',
            'Title' => 'string',
            'Type' => 'string',
            'Url' => 'https://example.com'
        ]
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/module-items/seo/publish-draft/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"SEOTitle\":\"string\",\"MetaDescription\":\"string\",\"CanonicalLink\":\"string\",\"SocialMetaTags\":\"string\",\"SeoPriority\":0,\"EnableAMP\":false,\"AMPContent\":\"string\",\"ShowPageForSearchEngine\":false,\"OpenGraphProperties\":{\"Image\":\"string\",\"Locale\":\"string\",\"Title\":\"string\",\"Type\":\"string\",\"Url\":\"https://example.com\"}}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "SEOTitle": "string",
  "MetaDescription": "string",
  "CanonicalLink": "string",
  "SocialMetaTags": "string",
  "SeoPriority": 0,
  "EnableAMP": false,
  "AMPContent": "string",
  "ShowPageForSearchEngine": false,
  "OpenGraphProperties": {
    "Image": "string",
    "Locale": "string",
    "Title": "string",
    "Type": "string",
    "Url": "https://example.com"
  }
}