OPoptimove
Overlay templates

Create an overlay template

Creates an overlay template. The HTML is validated, including Liquid syntax and the customer attributes it uses. Use GET /templates/overlay/brand-lookups to get the brand ids you can use in brandSettings.

post/templates/overlay

Request

  • Base URL
    https://api5.optimove.net/content/v1
  • URL
    https://api5.optimove.net/content/v1/templates/overlay
  • Auth
    API key in header X-API-KEY

Request body

namestring required

Template name. Must be unique (case-sensitive) among the tenant's templates.

folderIdstring uuid nullable

Folder to put the template in. Leave out for the root folder.

editorType'html' | 'visual' required

Editor the content is built with:

  • html: HTML code editor
  • visual: drag-and-drop editor

Example request

{
  "name": "Summer sale overlay",
  "editorType": "html",
  "payload": {
    "html": "<div>Hi {{customer.FirstName}}, our summer sale has started.</div>",
    "ttlMinutes": 2880
  },
  "code": {
    "header": "{% assign greeting = \"Hello\" %}"
  }
}

Response

The template was created.

idstring uuid required
campaignTemplateIdinteger required

Id of the template in Optimove campaigns.

namestring required
folderIdstring uuid nullable
editorType'html' | 'visual' required

Editor the content is built with:

  • html: HTML code editor
  • visual: drag-and-drop editor
createdAtstring date-time required
createdBystring required
updatedAtstring date-time required
updatedBystring required

Example response

{
  "name": "Summer sale overlay",
  "editorType": "html",
  "payload": {
    "html": "<div>Hi {{customer.FirstName}}, our summer sale has started.</div>",
    "ttlMinutes": 2880
  },
  "code": {
    "header": "{% assign greeting = \"Hello\" %}"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.