Open API v2 / CMS & Content / Content Templates

Content Templates

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/content-templates#

Retrieves a list of content templates 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
Aunique identifier. The technical ID of the template in the database. Read-only.
Contentstring · nullable
Template body (HTML). Contains markup with placeholders ({{pageContent}}), where the system inserts the dynamic page content.
FtpPathstring · nullable
File path. The physical location of the template file on the server or FTP storage. Read-only.
IsSystemboolean
System flag. True: the template is basic (system), it is usually forbidden to delete or rename. False: a custom template created by the administrator (set upon creation).
IsDefaultboolean
Default usage. Defines whether this template will be automatically selected for new pages of this type.
AmpContentstring · nullable
AMP markup. A special version of the template for Google Accelerated Mobile Pages. Contains markup with placeholders ({{pageContent}})
Namestring · nullable
Template name that is displayed in the admin panel.
Settingsobject
Technical configuration. A set of switches (UseGlobal, Enable, Disable) for managing the functionality of the page that uses this template. Contains [MainCSS],[RecaptchaJS],[EcommerceJS],[PaymentJS]
curl "https://your-site.webinone.com/api/v2/admin/content-templates" \
  -H "Authorization: Bearer <token>"
Response · 200
{
  "Items": [
    {
      "Id": 1,
      "Content": "string",
      "FtpPath": "string",
      "IsSystem": false,
      "IsDefault": false,
      "AmpContent": "string",
      "Name": "Example",
      "Settings": {
        "MainCSS": "UseGlobal",
        "RecaptchaJS": "UseGlobal",
        "EcommerceJS": "UseGlobal",
        "PaymentJS": "UseGlobal"
      }
    }
  ],
  "TotalItemsCount": 0
}
POST/api/v2/admin/content-templates#

Creates a new content template

Body parameters
Contentstring · nullable
The main HTML/text content. The body of the page that the user sees in a regular browser. Supports HTML markup, scripts, and styles. Must contain the {{pageContent}} liquid tag. Cannot be empty/absent (nullable: false).
IsDefaultboolean
Defines whether this content variant is the main one. If multiple variants exist for a single URL, the system will display the one where this is enabled. Disabled by default.
Namestringrequired
A human-readable name that is displayed to the user.
AmpContentstring · nullable
Content for the AMP version. A special simplified markup for Accelerated Mobile Pages (Google's accelerated mobile pages). Used for fast loading on mobile devices. Must contain the {{pageContent}} liquid tag. Cannot be empty/absent (nullable: false).
Settingsobjectrequired
Technical configurations. A group of settings that defines which external resources and scripts will be connected to the page. Flexible resource management is provided for each parameter in Settings.
Response
Idinteger
Aunique identifier. The technical ID of the template in the database. Read-only.
Contentstring · nullable
Template body (HTML). Contains markup with placeholders ({{pageContent}}), where the system inserts the dynamic page content.
FtpPathstring · nullable
File path. The physical location of the template file on the server or FTP storage. Read-only.
IsSystemboolean
System flag. True: the template is basic (system), it is usually forbidden to delete or rename. False: a custom template created by the administrator (set upon creation).
IsDefaultboolean
Default usage. Defines whether this template will be automatically selected for new pages of this type.
AmpContentstring · nullable
AMP markup. A special version of the template for Google Accelerated Mobile Pages. Contains markup with placeholders ({{pageContent}})
Namestring · nullable
Template name that is displayed in the admin panel.
Settingsobject
Technical configuration. A set of switches (UseGlobal, Enable, Disable) for managing the functionality of the page that uses this template. Contains [MainCSS],[RecaptchaJS],[EcommerceJS],[PaymentJS]
curl -X POST "https://your-site.webinone.com/api/v2/admin/content-templates" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Content":"string","IsDefault":false,"Name":"Example","AmpContent":"string","Settings":{"MainCSS":"UseGlobal","RecaptchaJS":"UseGlobal","EcommerceJS":"UseGlobal","PaymentJS":"UseGlobal"}}'
Response · 200
{
  "Id": 1,
  "Content": "string",
  "FtpPath": "string",
  "IsSystem": false,
  "IsDefault": false,
  "AmpContent": "string",
  "Name": "Example",
  "Settings": {
    "MainCSS": "UseGlobal",
    "RecaptchaJS": "UseGlobal",
    "EcommerceJS": "UseGlobal",
    "PaymentJS": "UseGlobal"
  }
}
GET/api/v2/admin/content-templates/{id}#

Retrieves a single content template

Parameters
idinteger · pathrequired
Content template id.
Response
Idinteger
Aunique identifier. The technical ID of the template in the database. Read-only.
Contentstring · nullable
Template body (HTML). Contains markup with placeholders ({{pageContent}}), where the system inserts the dynamic page content.
FtpPathstring · nullable
File path. The physical location of the template file on the server or FTP storage. Read-only.
IsSystemboolean
System flag. True: the template is basic (system), it is usually forbidden to delete or rename. False: a custom template created by the administrator (set upon creation).
IsDefaultboolean
Default usage. Defines whether this template will be automatically selected for new pages of this type.
AmpContentstring · nullable
AMP markup. A special version of the template for Google Accelerated Mobile Pages. Contains markup with placeholders ({{pageContent}})
Namestring · nullable
Template name that is displayed in the admin panel.
Settingsobject
Technical configuration. A set of switches (UseGlobal, Enable, Disable) for managing the functionality of the page that uses this template. Contains [MainCSS],[RecaptchaJS],[EcommerceJS],[PaymentJS]
curl "https://your-site.webinone.com/api/v2/admin/content-templates/1" \
  -H "Authorization: Bearer <token>"
Response · 200
{
  "Id": 1,
  "Content": "string",
  "FtpPath": "string",
  "IsSystem": false,
  "IsDefault": false,
  "AmpContent": "string",
  "Name": "Example",
  "Settings": {
    "MainCSS": "UseGlobal",
    "RecaptchaJS": "UseGlobal",
    "EcommerceJS": "UseGlobal",
    "PaymentJS": "UseGlobal"
  }
}
PUT/api/v2/admin/content-templates/{id}#

Updates an existing content template

Parameters
idinteger · pathrequired
Resource identifier.
Body parameters
Contentstring · nullable
The main HTML/text content. The body of the page that the user sees in a regular browser. Supports HTML markup, scripts, and styles. Must contain the {{pageContent}} liquid tag. Cannot be empty/absent (nullable: false).
IsDefaultboolean
Defines whether this content variant is the main one. If multiple variants exist for a single URL, the system will display the one where this is enabled. Disabled by default.
Namestringrequired
A human-readable name that is displayed to the user.
AmpContentstring · nullable
Content for the AMP version. A special simplified markup for Accelerated Mobile Pages (Google's accelerated mobile pages). Used for fast loading on mobile devices. Must contain the {{pageContent}} liquid tag. Cannot be empty/absent (nullable: false).
Settingsobjectrequired
Technical configurations. A group of settings that defines which external resources and scripts will be connected to the page. Flexible resource management is provided for each parameter in Settings.
Response
Idinteger
Aunique identifier. The technical ID of the template in the database. Read-only.
Contentstring · nullable
Template body (HTML). Contains markup with placeholders ({{pageContent}}), where the system inserts the dynamic page content.
FtpPathstring · nullable
File path. The physical location of the template file on the server or FTP storage. Read-only.
IsSystemboolean
System flag. True: the template is basic (system), it is usually forbidden to delete or rename. False: a custom template created by the administrator (set upon creation).
IsDefaultboolean
Default usage. Defines whether this template will be automatically selected for new pages of this type.
AmpContentstring · nullable
AMP markup. A special version of the template for Google Accelerated Mobile Pages. Contains markup with placeholders ({{pageContent}})
Namestring · nullable
Template name that is displayed in the admin panel.
Settingsobject
Technical configuration. A set of switches (UseGlobal, Enable, Disable) for managing the functionality of the page that uses this template. Contains [MainCSS],[RecaptchaJS],[EcommerceJS],[PaymentJS]
curl -X PUT "https://your-site.webinone.com/api/v2/admin/content-templates/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Content":"string","IsDefault":false,"Name":"Example","AmpContent":"string","Settings":{"MainCSS":"UseGlobal","RecaptchaJS":"UseGlobal","EcommerceJS":"UseGlobal","PaymentJS":"UseGlobal"}}'
Response · 200
{
  "Id": 1,
  "Content": "string",
  "FtpPath": "string",
  "IsSystem": false,
  "IsDefault": false,
  "AmpContent": "string",
  "Name": "Example",
  "Settings": {
    "MainCSS": "UseGlobal",
    "RecaptchaJS": "UseGlobal",
    "EcommerceJS": "UseGlobal",
    "PaymentJS": "UseGlobal"
  }
}
DELETE/api/v2/admin/content-templates/{id}#

Deletes an existing content template

Parameters
idinteger · pathrequired
Resource identifier.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/content-templates/1" \
  -H "Authorization: Bearer <token>"