banner Object

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

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

You can use the schema below to create or edit your own Banner 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"
        },
        "content": {
            "type": "string"
        },
        "authorId": {
            "type": "string"
        },
        "mode": {
            "type": "string",
            "enum": ["float", "expanded"]
        },
        "placement": {
            "type": "string",
            "enum": ["top", "bottom"]
        },
        "pattern": {
            "type": "string"
        },
        "textAlignment": {
            "type": "string",
            "enum": ["left", "center", "right"]
        },
        "linkMode": {
            "type": "string",
            "enum": ["normal", "button", "fancy"]
        },
        "closeBehavior": {
            "type": "string",
            "enum": ["forget", "remember"]
        },
        "scrollBehavior": {
            "type": "string",
            "enum": ["follow", "stationary"]
        },
        "cornerStyle": {
            "type": "string",
            "enum": ["cornered", "dubbed", "round"]
        },
        "URLTarget": {
            "type": "string",
            "enum": ["_blank", "_parent"]
        },
        "shadow": {
            "type": "boolean"
        },
        "verticalPadding": {
            "type": "string"
        },
        "showCloseButton": {
            "type": "boolean"
        },
        "JColorStudio": {
            "type": "object",
            "properties": {
                "contentBackground": {
                    "type": "string"
                },
                "contentText": {
                    "type": "string"
                },
                "contentShadow": {
                    "type": "string"
                },
                "linkBackground": {
                    "type": "string"
                },
                "linkText": {
                    "type": "string"
                },
                "closeButton": {
                    "type": "string"
                },
                "patternColor1": {
                    "type": "string"
                },
                "patternColor2": {
                    "type": "string"
                },
                "patternColor3": {
                    "type": "string"
                }
            },
            "required": [
                "contentBackground",
                "contentText",
                "contentShadow",
                "linkBackground",
                "linkText",
                "closeButton",
                "patternColor1",
                "patternColor2",
                "patternColor3"
            ]
        },
        "JFontStudio": {
            "type": "object",
            "properties": {
                "fontFamily": {
                    "type": "string"
                },
                "contentSize": {
                    "type": "string"
                },
                "linkSize": {
                    "type": "string"
                }
            },
            "required": [
                "fontFamily",
                "contentSize",
                "linkSize"
            ]
        },
        "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"]
}