facePop object

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

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

You can use the schema below to create or edit your own FacePop 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"
    },
    "authorId": {
      "type": "string"
    },
    "placement": {
      "type": "string",
      "enum": ["left", "right"]
    },
    "shadow": {
      "type": "string",
      "enum": ["no-shadow", "dim", "medium", "spotlight"]
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "JMargin": {
      "type": "object",
      "properties": {
        "vertical": {
          "type": "string"
        },
        "horizontal": {
          "type": "string"
        }
      },
      "required": ["vertical", "horizontal"]
    },
    "JPlayer": {
      "type": "object",
      "properties": {
        "width": {
          "type": "string",
          "pattern": "^\\d+px$"
        },
        "height": {
          "type": "string",
          "pattern": "^\\d+px$"
        },
        "controls": {
          "type": "string",
          "enum": ["show", "hide", "hover-only"]
        },
        "openMode": {
          "type": "string",
          "enum": ["center", "corner"]
        },
        "loopVideo": {
          "type": "boolean"
        },
        "startMuted": {
          "type": "boolean"
        },
        "borderRadius": {
          "type": "string",
          "pattern": "^\\d+px$"
        },
        "controlsSize": {
          "type": "string",
          "pattern": "^\\d+px$"
        },
        "seekerHeight": {
          "type": "string",
          "pattern": "^\\d+px$"
        },
        "minimizeIcon": {
          "type": "string"
        },
        "fullScreenMobile": {
          "type": "boolean"
        }
      },
      "required": [
        "width",
        "height",
        "controls",
        "openMode",
        "loopVideo",
        "startMuted",
        "borderRadius",
        "controlsSize",
        "seekerHeight",
        "minimizeIcon",
        "fullScreenMobile"
      ]
    },
    "JCTA": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string"
        },
        "URL": {
          "type": "string"
        },
        "URLTarget": {
          "type": "string",
          "enum": ["_blank", "_self", "_top"]
        },
        "icon": {
          "type": "string"
        },
        "showAt": {
          "type": "string",
          "enum": ["always", "after-begin", "before-end", "after-end", "never"]
        },
        "afterClick": {
          "type": "string",
          "enum": ["do-nothing", "hide-widget"]
        },
        "corners": {
          "type": "string",
          "enum": ["round", "dubbed", "sharp"]
        },
        "buttonMode": {
          "type": "string",
          "enum": ["button", "link", "outline"]
        }
      },
      "required": ["text", "URL", "URLTarget", "icon", "showAt", "afterClick", "corners", "buttonMode"]
    },
    "JToggle": {
      "type": "object",
      "properties": {
        "borderRadius": {
          "type": "string",
          "pattern": "^\\d+px$"
        },
        "width": {
          "type": "string",
          "pattern": "^\\d+px$"
        },
        "height": {
          "type": "string",
          "pattern": "^\\d+px$"
        },
        "playButton": {
          "type": "string",
          "enum": ["hide", "show", "hover-only"]
        },
        "closeable": {
          "type": "boolean"
        }
      },
      "required": ["borderRadius", "width", "height", "playButton", "closeable"]
    },
    "JVideo": {
      "type": "object",
      "properties": {
        "videoId": {
          "type": "string"
        },
        "libraryId": {
          "type": "string"
        },
        "ratio": {
          "type": "string"
        },
        "width": {
          "type": "string"
        },
        "height": {
          "type": "string"
        },
        "sourceURL": {
          "type": "string"
        },
        "thumbnail": {
          "type": "object",
          "properties": {
            "static": {
              "type": "string"
            },
            "animated": {
              "type": "string"
            }
          },
          "required": ["static", "animated"]
        }
      },
      "required": ["videoId", "libraryId", "ratio", "width", "height", "sourceURL", "thumbnail"]
    },
    "JColorStudio": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "shadow": {
          "type": "string"
        },
        "ctaIcon": {
          "type": "string"
        },
        "ctaText": {
          "type": "string"
        },
        "overlay": {
          "type": "string"
        },
        "authorName": {
          "type": "string"
        },
        "ctaOutline": {
          "type": "string"
        },
        "togglePlay": {
          "type": "string"
        },
        "toggleCloseIcon": {
          "type": "string"
        },
        "toggleCloseBorder": {
          "type": "string"
        },
        "toggleCloseBackground": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "playerSeeker": {
          "type": "string"
        },
        "ctaBackground": {
          "type": "string"
        },
        "playerControls": {
          "type": "string"
        },
        "authorOccupation": {
          "type": "string"
        },
        "centerModeBackground": {
          "type": "string"
        }
      },
      "required": [
        "title",
        "shadow",
        "ctaIcon",
        "ctaText",
        "overlay",
        "authorName",
        "ctaOutline",
        "togglePlay",
        "toggleCloseIcon",
        "toggleCloseBorder",
        "toggleCloseBackground",
        "description",
        "playerSeeker",
        "ctaBackground",
        "playerControls",
        "authorOccupation",
        "centerModeBackground"
      ]
    },
    "JFontStudio": {
      "type": "object",
      "properties": {
        "ctaSize": {
          "type": "string"
        },
        "titleSize": {
          "type": "string"
        },
        "fontFamily": {
          "type": "string"
        },
        "authorNameSize": {
          "type": "string"
        },
        "descriptionSize": {
          "type": "string"
        },
        "authorOccupationSize": {
          "type": "string"
        }
      },
      "required": [
        "ctaSize",
        "titleSize",
        "fontFamily",
        "authorNameSize",
        "descriptionSize",
        "authorOccupationSize"
      ]
    },
    "JInstantEmbed": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "customCSS": {
      "type": "string"
    },
    "customJS": {
      "type": "string"
    },
    "enableSDK": {
      "type": "boolean"
    },
    "enableTracking": {
      "type": "boolean"
    },
    "answerlyBranding": {
      "type": "boolean"
    }
  },
  "required": ["id", "name", "companyId"]
}