PUBLISH

Publish EyeLevel conversation flow associated with the given API key

post
https://api.eyelevel.ai/v1/partner
/publish/:apiKey/:id
PUBLISH
Request
{
    "publish": {
        "qrTheme": {
            "background":     "STRING",
            "foreground":     "STRING",
            "hasBorder":      BOOLEAN,
            "imageUrl":       "STRING",
            "textIdentifier": "STRING"
        }
    }
}
background
OPTIONAL - String
Validation:
A valid hex color code
The background color of the QR code. We highly recommend a lighter color so that the QR code can more easily be detected by phone cameras. If this value is set, it will override any themes associated with the chat flow.
foreground
OPTIONAL - String
Validation:
A valid hex color code
The foreground color of the QR code. We highly recommend a darker color so that the QR code can more easily be detected by phone cameras. If this value is set, it will override any themes associated with the chat flow.
hasBorder
OPTIONAL - Boolean
Setting this attribute true will add a margin around the edges of the QR code with the background color. The default value is false. If this value is set, it will override any themes associated with the chat flow.
imageUrl
OPTIONAL - String
Validation:
A valid URL including protocol http(s)
The URL for the hosted image. This image will be applied to the center of the QR code. If this value is set, it will override any themes associated with the chat flow.
textIdentifier
OPTIONAL - String
Validation:
255 character limit
A human readable string that is displayed below the QR code. If this value is set, it will override any themes associated with the chat flow.
Response
{
    "publish": {
        "adId":       "STRING",
        "adSetId":    "STRING",
        "campaignId": "STRING",
        "qrLinks":    {
            "[email protected]":  "STRING",
            "[email protected]":  "STRING",
            "[email protected]": "STRING",
            "svg":      "STRING",
        },
        platforms: [
            "ENUMERATED STRING"
        ],
        "url":        "STRING",
    }
}
adId
The ad identifier where the chat flow was published.
adSetId
The ad set identifier where the chat flow was published.
campaignId
The campaign identifier where the chat flow was published.
platforms
The marketing channels where the chat flow has been published. The values will be one of:
web - for websites
linkedin - for LinkedIn ads
instagram - for Instagram web ads
email - for email marketing
gads - for Google search ads
fbads - for Facebook web ads
facebook - for Facebook platform Messenger ads (includes Instagram)
youtube - for YouTube ads
fbpage - for Facebook Pages
[email protected]
The URL for the 200 x 200 pixel hosted QR code image. The URL is valid for 24 hours.
[email protected]
The URL for the 500 x 500 pixel hosted QR code image. The URL is valid for 24 hours.
[email protected]
The URL for the 1000 x 1000 pixel hosted QR code image. The URL is valid for 24 hours.
svg
The URL for the hosted QR code image. The URL is valid for 24 hours.
url
The URL that can be used to launch the chat flow.

GET PUBLISH INFO

Next - Documentation

ANALYTICS

Last modified 1yr ago