Change Log

  • 19-Jun-2024 | v7.0.0 | All new article

Contributors:

Adam Wilson - Logo Pogo

Content Templates API

Create, Retrieve, Update and Delete Content Templates via the public API endpoint using "where" filtering.

GET Content Templates List

Retrieves a list of Content Templates as a JSON response based on your provided query parameters.

/api/v2/admin/content-templates

Data / Response:

{
    "Where" : {},
    "Order_By" : "Id",
    "Offset" : 0,
    "Limit" : 100,
}

{
  "Items": [
    {
      "Id": 0,
      "Content": "string",
      "FtpPath": "string",
      "IsSystem": true,
      "IsDefault": true,
      "AmpContent": "string",
      "Name": "string",
      "Settings": {
        "MainCSS": "UseGlobal",
        "RecaptchaJS": "UseGlobal",
        "EcommerceJS": "UseGlobal",
        "PaymentJS": "UseGlobal"
      }
    }
  ],
  "TotalItemsCount": 0
}

POST Content Template Create

Creates a new Content Template based on the provided data.

/api/v2/admin/content-templates

Data / Response:

{
  "Content": "string",
  "IsDefault": true,
  "Name": "string",
  "AmpContent": "string",
  "Settings": {
    "MainCSS": "UseGlobal",
    "RecaptchaJS": "UseGlobal",
    "EcommerceJS": "UseGlobal",
    "PaymentJS": "UseGlobal"
  }
}

{
  "Id": 0,
  "Content": "string",
  "IsDefault": true,
  "Name": "string",
  "AmpContent": "string",
  "Settings": {
    "MainCSS": "UseGlobal",
    "RecaptchaJS": "UseGlobal",
    "EcommerceJS": "UseGlobal",
    "PaymentJS": "UseGlobal"
  }
}

GET Content Template Item

Retrieves a single Content Template based on the ID passed in the endpoint URL.

/api/v2/admin/content-templates/{id}

Data / Response:

N/A

{
  "Id": 0,
  "Content": "string",
  "IsDefault": true,
  "Name": "string",
  "AmpContent": "string",
  "Settings": {
    "MainCSS": "UseGlobal",
    "RecaptchaJS": "UseGlobal",
    "EcommerceJS": "UseGlobal",
    "PaymentJS": "UseGlobal"
  }
}

PUT Content Template Update

Updates a single Content Template based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/content-templates/{id}

Data / Response:

{
  "Id": 0,
  "Content": "string",
  "IsDefault": true,
  "Name": "string",
  "AmpContent": "string",
  "Settings": {
    "MainCSS": "UseGlobal",
    "RecaptchaJS": "UseGlobal",
    "EcommerceJS": "UseGlobal",
    "PaymentJS": "UseGlobal"
  }
}

{
  "Id": 0,
  "Content": "string",
  "IsDefault": true,
  "Name": "string",
  "AmpContent": "string",
  "Settings": {
    "MainCSS": "UseGlobal",
    "RecaptchaJS": "UseGlobal",
    "EcommerceJS": "UseGlobal",
    "PaymentJS": "UseGlobal"
  }
}

DELETE Content Template Delete

Deletes a single Content Template based on the ID passed in the endpoint URL.

/api/v2/admin/content-templates/{id}

Data / Response:

N/A

Status 204