popupHero Object

If you're planning on using the Popup Hero API, you will be asked to insert a JSON object called "popupHero" along with your requests. 

This JSON object acts as a blueprint for your target popup. 

You can use the schema below to create or edit your own Popup Hero widget through the API: 

All of the object keys are optional, except for id companyId and name

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "companyId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "impex": {
      "type": "object"
    },
    "html": {
      "type": "string"
    },
    "JSize": {
      "type": "object",
      "properties": {
        "width": {
          "type": "string"
        },
        "height": {
          "type": "string"
        }
      },
      "required": ["width", "height"]
    },
    "JPadding": {
      "type": "object",
      "properties": {
        "vertical": {
          "type": "string"
        },
        "horizontal": {
          "type": "string"
        }
      },
      "required": ["vertical", "horizontal"]
    },
    "shadow": {
      "type": "string",
      "enum": ["none", "dim", "medium", "spotlight"]
    },
    "overlay": {
      "type": "string",
      "enum": ["invisible", "blur", "color"]
    },
    "placement": {
      "type": "string",
      "enum": ["left", "bottom-left", "top-left", "right", "bottom-right", "top-right", "center"]
    },
    "cornerRadius": {
      "type": "string"
    },
    "backgroundImage": {
      "type": "string"
    },
    "showCloseButton": {
      "type": "boolean"
    },
    "closeBehavior": {
      "type": "string",
      "enum": ["forget", "remember"]
    },
    "closeIcon": {
      "type": "string"
    },
    "JColorStudio": {
      "type": "object",
      "properties": {
        "backgroundColor": {
          "type": "string"
        },
        "overlayColor": {
          "type": "string"
        },
        "closeButtonColor": {
          "type": "string"
        },
        "shadowColor": {
          "type": "string"
        }
      },
      "required": ["backgroundColor", "overlayColor", "closeButtonColor", "shadowColor"]
    },
    "JInstantEmbed": {
      "type": "array"
    },
    "customCSS": {
      "type": "string"
    },
    "customJS": {
      "type": "string"
    },
    "enableSDK": {
      "type": "boolean"
    },
    "enableTracking": {
      "type": "boolean"
    },
    "answerlyBranding": {
      "type": "boolean"
    }
  },
  "required": ["id", "name", "companyId"]
}