API Reference

Create an overlay template

post
https://api5.optimove.net/content/v1/templates/overlay

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 200

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

uuid | null

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

string
enum
required

Editor the content is built with:

  • html: HTML code editor
  • visual: drag-and-drop editor
Allowed:
payload
object
required
brandSettings
array of objects
required
length ≥ 1

Brands the template is assigned to. Each brand can appear only once.

brandSettings*
string
required

Id of a brand from GET /templates/overlay/brand-lookups.

code
object | null

Custom code of the block.

Responses

401

The X-API-KEY header is missing or the API key is not valid.

403

The API key doesn't have the admin role, or the tenant isn't allowed to change this item.

Updated 20 minutes ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 20 minutes ago

Did this page help you?