Skip to main content
GET
/
prod
/
prompt
/
{id}
Get Opt-in Prompt
curl --request GET \
  --url https://api.aimtell.com/prod/prompt/{id} \
  --header 'X-Authorization-Api-Key: <api-key>'
{
  "id": "123",
  "uid": "12abcd3456e7",
  "idSite": "147",
  "name": "Prompt 1",
  "header_text": "Want updates?",
  "header_text_color": "#000000",
  "body_text": "Get the latest and greatest",
  "body_text_color": "#000000",
  "cancel_button_text": "No, thanks",
  "cancel_button_text_color": "#4e99cf",
  "cancel_button_color": "#ffffff",
  "approve_button_text": "Yes, please",
  "approve_button_text_color": "#4e99cf",
  "approve_button_color": "#ffffff",
  "active": "1",
  "icon_url": "https://cdn.aimtell.io/user/uploads/147-1588184063.png",
  "prompt_color": "",
  "prompt_type": "3",
  "prompt_position": "",
  "prompt_sticky": "0",
  "createdAt": "2020-04-29 18:13:33",
  "updatedAt": "2020-07-28 18:39:51",
  "code": "<style>@-webkit-keyframes _aimtellShowPushBox {\n\t\t\t    from {top: 0;}\n\t\t\t    to {top: 15px;}\n\t\t\t}\n\n\t\t\t@keyframes _aimtellShake {\n\t\t\t  10%, 90% {\n\t\t\t    transform: translate3d(-1px, 0, 0);\n\t\t\t  }\n\t\t\t  \n\t\t\t  20%, 80% {\n\t\t\t    transform: translate3d(1px, 0, 0);\n\t\t\t  }\n\n\t\t\t  30%, 50%, 70% {\n\t\t\t    transform: translate3d(-1px, 0, 0);\n\t\t\t  }\n\n\t\t\t  40%, 60% {\n\t\t\t    transform: translate3d(1px, 0, 0);\n\t\t\t  }\n\t\t\t} \n\t\t\t\tpushboxcontainer{\n\t\t\t\t    position:fixed;\n\t\t\t\t    z-index:1000201;\n\t\t\t\t    top:15px;\n\t\t\t\t    left:35%;\n\t\t\t\t    font-family:times;\n\t\t\t\t    display: block;\n\t\t\t\t    -webkit-animation: _aimtellShowPushBox 1s forwards;\n\t\t\t\t    animation: _aimtellShowPushBox 1s forwards;\n\n\t\t\t\t}\n\t\t\t\tpushbox {\n\t\t\t\t    position: relative;\n\t\t\t\t    background: #f7f7f7;\n\t\t\t\t    -webkit-border-radius: 4px;\n\t\t\t\t    -moz-border-radius: 4px;\n\t\t\t\t    border-radius: 4px; \n\t\t\t\t    width: 450px; \n\t\t\t\t    padding: 10px;\n\t\t\t\t    padding-top:20px;\n\t\t\t\t    display:block;\n\t\t\t\t    border:2px solid #E9E9E9;\n\t\t\t\t    border-top:3px solid #ffffff;\n\t\t\t\t    box-shadow: 20px 20px 35px -5px rgba(39,55,74,.75), 0 15px 40px 10px rgba(39, 55, 74, 0.25);\n\t\t\t\t    font-size:16px;\n\t\t\t\t    line-height:20px;\n\t\t\t\t    letter-spacing:normal;\n\t\t\t\t    text-transform: initial;\n\t\t\t\t}\n\n\t\t\t\t\n\t\t\t\tpushbox noticon{\n\t\t\t\t    width:25%;\n\t\t\t\t    float:left;\n\t\t\t\t    display: block;\n\t\t\t\t    margin:0 auto;\n\t\t\t\t    text-align: center;\n\t\t\t\t}\n\n\t\t\t\tpushbox noticon img{\n\t\t\t\t\twidth:75px;\n\t\t\t\t\theight:75px;\n\t\t\t\t\tborder:2px solid #E9E9E9;\n\t\t\t\t}\n\n\t\t\t\t\n\t\t\t\tpushbox notibody{\n\t\t\t\t    width:72%;\n\t\t\t\t    float:left;\n\t\t\t\t    text-align:left;\n\t\t\t\t    font-size:16px;\n\t\t\t\t    padding-left:10px;\n\t\t\t\t}\n\n\t\t\t\tpushbox noticlose{\n\t\t\t\t    position:absolute;\n\t\t\t\t    right:15px;\n\t\t\t\t    top:15px;\n\t\t\t\t    color:#C9C9C9;\n\t\t\t\t    cursor: pointer;\n\t\t\t\t    z-index:1000201;\n\t\t\t\t}\n\n\t\t\t\tpushbox pushbox-cta buttons{\n\t\t\t\t  position:relative;\n\t\t\t\t  display:inline-block;\n\t\t\t\t  clear:both;\n\t\t\t\t  width:100%;\n\t\t\t\t  font-size:16px;\n\t\t\t\t  padding-top:10px;\n\t\t\t\t  padding-bottom:10px;\n\t\t\t\t}\n\n\t\t\t\tpushbox pushbox-cta buttons button-approve, pushbox pushbox-cta buttons button-deny{\n\t\t\t\t    display:inline-block; \n\t\t\t\t    margin-top:10px;\n\t\t\t\t    float:right;\n\t\t\t\t    margin-right:10px;\n\t\t\t\t    min-width: 75px\n\t\t\t\t}\n\n\t\t\t\tpushbox teaser{\n\t\t\t\t    font-weight:700;\n\t\t\t\t    font-size:17px;\n\t\t\t\t    color: #000000;\n\t\t\t\t    padding-bottom:7px;\n\t\t\t\t}\n\n\t\t\t\tpushbox teaser, pushbox teaser-byline{\n\t\t\t\t  display:block;\n\t\t\t\t  position:relative;\n\t\t\t\t}\n\n\t\t\t\tpushbox teaser-byline{\n\t\t\t\t    color: #000000;\n\t\t\t\t}\n\n\t\t\t\tpushbox button-approve,pushbox button-deny{\n\t\t\t\t  cursor: pointer;\n\t\t\t\t  transition: all 60ms ease-in-out;\n\t\t\t\t  text-align: center;\n\t\t\t\t  white-space: nowrap;\n\t\t\t\t  color: #fff;\n\t\t\t\t  border: 0 none;\n\t\t\t\t  border-radius: 4px;\n\t\t\t\t  padding:5px 10px;\n\t\t\t\t}\n\n\t\t\t\tpushbox img._aimtellBell{\n\t\t\t\t  margin:0 auto;\n\t\t\t\t  cursor:pointer;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\t\n\t\t\t\tpushbox powered{\n\t\t\t\t  font-size:14px;\n\t\t\t\t  padding:5px 0px;\n\t\t\t\t  text-align:left;\n\t\t\t\t  display:inline-block;\n\t\t\t\t  margin-left:10px;\n\t\t\t\t  margin-top:8px;\n\t\t\t\t  opacity:0.5;\n\t\t\t\t}\n\n\t\t\t\tpushbox powered svg{\n\t\t\t\t\twidth:14px;\n\t\t\t\t\tfill: #000;\n\t\t\t\t\tposition:relative;\n\t\t\t\t\ttop:3px;\n\t\t\t\t}\n\n\t\t\t\tpushbox powered a, pushbox powered a:hover{\n\t\t\t\t\t color: #000;\n\t\t\t\t}\n\n\n\n\t\t\t\tpushbox ._aimtellPromptApprove{\n\t\t\t\t  background-color: #ffffff;\n\t\t\t\t  color:#4e99cf;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\tpushbox ._aimtellPromptDeny{\n\t\t\t\t  background-color: #ffffff;\n\t\t\t\t  color:#4e99cf;\n\t\t\t\t}  \n\t\t\t\t@media only screen and (max-device-width: 720px) and (orientation: landscape){\n\t\t\t\t\tpushbox{\n\t\t\t\t\t\tdisplay:none;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t@media (max-width: 480px){\n\t\t\t\t\t pushboxcontainer{\n\t\t\t\t\t    left:0px !important;\n\t\t\t\t\t } \n\t\t\t\t\t \n\t\t\t\t\t pushbox{\n\t\t\t\t\t    border-radius: 0px !important;\n\t\t\t\t\t    width:initial;\n\t\t\t\t\t    position:fixed !important;\n\t\t\t\t\t    bottom: 0px !important;\n\t\t\t\t\t    min-height:150px;\n\t\t\t\t\t    padding-top:10px;\n\t\t\t\t\t    box-shadow: none;\n\n\t\t\t\t\t }\n\n\t\t\t\t\t pushbox-cta{\n\t\t\t\t\t \tdisplay:block;\n\t\t\t\t\t \tpadding-top:10px;\n\t\t\t\t\t }\n\n\t\t\t\t\t pushbox teaser, pushbox teaser-byline, pushbox pushbox-cta buttons{\n\t\t\t\t  \t\tfont-size:14px;\n\t\t\t\t\t}\n\n\t\t\t\t\n\t\t\t\t\tpushbox noticon img{\n\t\t\t\t\t\twidth:65px;\n\t\t\t\t\t\theight:65px;\n\t\t\t\t\t\tborder:2px solid #E9E9E9;\n\t\t\t\t\t}\n\n\t\t\t\t\tpushbox powered{\n\t\t\t\t\t  font-size:10px;\n\t\t\t\t\t  margin-top:9px;\n\t\t\t\t\t}\n\n\t\t\t\t}\n\t\t\t\t</style><div id='aimtellPrompt_overlay'><pushboxcontainer id='pushboxcontainer'>\n\t\t\t\t<img style='position:absolute; visibility:hidden' height='0' width='0' src='https://analytics.aimtell.com/prompt-view?id_site=147&prompt_type=3&prompt_id=3793'>\n\t\t\t\t    <pushbox>\n\t\t\t\t      <pushbox-cta>\n\t\t\t\t        <noticon class='_aimtellBell'>\n\t\t\t\t\t\t\t<img src='https://cdn.aimtell.io/user/uploads/147-1588184063.png'>\n\t\t\t\t        </noticon>\n\t\t\t\t        \n\t\t\t\t        <notibody>\n\t\t\t\t            <teaser>Want updates?</teaser>\n\t\t\t\t            <teaser-byline>Get the latest and greatest</teaser-byline>\n\t\t\t\t        </notibody>\n\t\t\t\t        <buttons>\n\t\t\t\t        \t<powered><a target='_BLANK' href='https://aimtell.com/liked-our-push-notification-widget?domain=website.com&utm_source=aimtell&utm_medium=prompt&utm_campaign=147&utm_content=type-3'><svg enable-background='new 0 0 512 512' version='1.1' viewBox='0 0 512 512' xml:space='preserve' xmlns='http://www.w3.org/2000/svg'><path d='m400.27 175.6c-1.399-3.004-4.412-4.932-7.731-4.932h-101.12l99.797-157.57c1.664-2.628 1.766-5.956 0.265-8.678-1.502-2.731-4.37-4.421-7.476-4.421h-136.53c-3.234 0-6.187 1.826-7.637 4.719l-128 256c-1.323 2.637-1.178 5.777 0.375 8.294 1.562 2.517 4.301 4.053 7.262 4.053h87.748l-95.616 227.09c-1.63 3.883-0.179 8.388 3.413 10.59 1.382 0.845 2.918 1.254 4.446 1.254 2.449 0 4.864-1.05 6.537-3.029l273.07-324.27c2.141-2.542 2.602-6.092 1.203-9.104z'/></svg> by Aimtell</a></powered>\n\t\t\t\t        \t<button-approve onclick='_aimtellPromptApprove()' class='_aimtellPromptApprove'>Yes, please</button-approve>\n\t\t\t\t        \t <button-deny onclick='_aimtellPromptDeny()' class='_aimtellPromptDeny'>No, thanks</button-deny>  \n\t\t\t\t         </buttons>\n\t\t\t\t\t\t\n\t\t\t\t      </pushbox-cta>\n\t\t\t\t    </pushbox>\n\t\t\t\t</pushboxcontainer></div>"
}

Authorizations

X-Authorization-Api-Key
string
header
default:""
required

Path Parameters

id
string
required

Prompt ID

Response

200

id
string
Example:

"123"

uid
string
Example:

"12abcd3456e7"

idSite
string
Example:

"147"

name
string
Example:

"Prompt 1"

header_text
string
Example:

"Want updates?"

header_text_color
string
Example:

"#000000"

body_text
string
Example:

"Get the latest and greatest"

body_text_color
string
Example:

"#000000"

cancel_button_text
string
Example:

"No, thanks"

cancel_button_text_color
string
Example:

"#4e99cf"

cancel_button_color
string
Example:

"#ffffff"

approve_button_text
string
Example:

"Yes, please"

approve_button_text_color
string
Example:

"#4e99cf"

approve_button_color
string
Example:

"#ffffff"

active
string
Example:

"1"

icon_url
string
Example:

"https://cdn.aimtell.io/user/uploads/147-1588184063.png"

prompt_color
string
Example:

""

prompt_type
string
Example:

"3"

prompt_position
string
Example:

""

prompt_sticky
string
Example:

"0"

createdAt
string
Example:

"2020-04-29 18:13:33"

updatedAt
string
Example:

"2020-07-28 18:39:51"

code
string
Example:

"<style>@-webkit-keyframes _aimtellShowPushBox {\n\t\t\t from {top: 0;}\n\t\t\t to {top: 15px;}\n\t\t\t}\n\n\t\t\t@keyframes _aimtellShake {\n\t\t\t 10%, 90% {\n\t\t\t transform: translate3d(-1px, 0, 0);\n\t\t\t }\n\t\t\t \n\t\t\t 20%, 80% {\n\t\t\t transform: translate3d(1px, 0, 0);\n\t\t\t }\n\n\t\t\t 30%, 50%, 70% {\n\t\t\t transform: translate3d(-1px, 0, 0);\n\t\t\t }\n\n\t\t\t 40%, 60% {\n\t\t\t transform: translate3d(1px, 0, 0);\n\t\t\t }\n\t\t\t} \n\t\t\t\tpushboxcontainer{\n\t\t\t\t position:fixed;\n\t\t\t\t z-index:1000201;\n\t\t\t\t top:15px;\n\t\t\t\t left:35%;\n\t\t\t\t font-family:times;\n\t\t\t\t display: block;\n\t\t\t\t -webkit-animation: _aimtellShowPushBox 1s forwards;\n\t\t\t\t animation: _aimtellShowPushBox 1s forwards;\n\n\t\t\t\t}\n\t\t\t\tpushbox {\n\t\t\t\t position: relative;\n\t\t\t\t background: #f7f7f7;\n\t\t\t\t -webkit-border-radius: 4px;\n\t\t\t\t -moz-border-radius: 4px;\n\t\t\t\t border-radius: 4px; \n\t\t\t\t width: 450px; \n\t\t\t\t padding: 10px;\n\t\t\t\t padding-top:20px;\n\t\t\t\t display:block;\n\t\t\t\t border:2px solid #E9E9E9;\n\t\t\t\t border-top:3px solid #ffffff;\n\t\t\t\t box-shadow: 20px 20px 35px -5px rgba(39,55,74,.75), 0 15px 40px 10px rgba(39, 55, 74, 0.25);\n\t\t\t\t font-size:16px;\n\t\t\t\t line-height:20px;\n\t\t\t\t letter-spacing:normal;\n\t\t\t\t text-transform: initial;\n\t\t\t\t}\n\n\t\t\t\t\n\t\t\t\tpushbox noticon{\n\t\t\t\t width:25%;\n\t\t\t\t float:left;\n\t\t\t\t display: block;\n\t\t\t\t margin:0 auto;\n\t\t\t\t text-align: center;\n\t\t\t\t}\n\n\t\t\t\tpushbox noticon img{\n\t\t\t\t\twidth:75px;\n\t\t\t\t\theight:75px;\n\t\t\t\t\tborder:2px solid #E9E9E9;\n\t\t\t\t}\n\n\t\t\t\t\n\t\t\t\tpushbox notibody{\n\t\t\t\t width:72%;\n\t\t\t\t float:left;\n\t\t\t\t text-align:left;\n\t\t\t\t font-size:16px;\n\t\t\t\t padding-left:10px;\n\t\t\t\t}\n\n\t\t\t\tpushbox noticlose{\n\t\t\t\t position:absolute;\n\t\t\t\t right:15px;\n\t\t\t\t top:15px;\n\t\t\t\t color:#C9C9C9;\n\t\t\t\t cursor: pointer;\n\t\t\t\t z-index:1000201;\n\t\t\t\t}\n\n\t\t\t\tpushbox pushbox-cta buttons{\n\t\t\t\t position:relative;\n\t\t\t\t display:inline-block;\n\t\t\t\t clear:both;\n\t\t\t\t width:100%;\n\t\t\t\t font-size:16px;\n\t\t\t\t padding-top:10px;\n\t\t\t\t padding-bottom:10px;\n\t\t\t\t}\n\n\t\t\t\tpushbox pushbox-cta buttons button-approve, pushbox pushbox-cta buttons button-deny{\n\t\t\t\t display:inline-block; \n\t\t\t\t margin-top:10px;\n\t\t\t\t float:right;\n\t\t\t\t margin-right:10px;\n\t\t\t\t min-width: 75px\n\t\t\t\t}\n\n\t\t\t\tpushbox teaser{\n\t\t\t\t font-weight:700;\n\t\t\t\t font-size:17px;\n\t\t\t\t color: #000000;\n\t\t\t\t padding-bottom:7px;\n\t\t\t\t}\n\n\t\t\t\tpushbox teaser, pushbox teaser-byline{\n\t\t\t\t display:block;\n\t\t\t\t position:relative;\n\t\t\t\t}\n\n\t\t\t\tpushbox teaser-byline{\n\t\t\t\t color: #000000;\n\t\t\t\t}\n\n\t\t\t\tpushbox button-approve,pushbox button-deny{\n\t\t\t\t cursor: pointer;\n\t\t\t\t transition: all 60ms ease-in-out;\n\t\t\t\t text-align: center;\n\t\t\t\t white-space: nowrap;\n\t\t\t\t color: #fff;\n\t\t\t\t border: 0 none;\n\t\t\t\t border-radius: 4px;\n\t\t\t\t padding:5px 10px;\n\t\t\t\t}\n\n\t\t\t\tpushbox img._aimtellBell{\n\t\t\t\t margin:0 auto;\n\t\t\t\t cursor:pointer;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\t\n\t\t\t\tpushbox powered{\n\t\t\t\t font-size:14px;\n\t\t\t\t padding:5px 0px;\n\t\t\t\t text-align:left;\n\t\t\t\t display:inline-block;\n\t\t\t\t margin-left:10px;\n\t\t\t\t margin-top:8px;\n\t\t\t\t opacity:0.5;\n\t\t\t\t}\n\n\t\t\t\tpushbox powered svg{\n\t\t\t\t\twidth:14px;\n\t\t\t\t\tfill: #000;\n\t\t\t\t\tposition:relative;\n\t\t\t\t\ttop:3px;\n\t\t\t\t}\n\n\t\t\t\tpushbox powered a, pushbox powered a:hover{\n\t\t\t\t\t color: #000;\n\t\t\t\t}\n\n\n\n\t\t\t\tpushbox ._aimtellPromptApprove{\n\t\t\t\t background-color: #ffffff;\n\t\t\t\t color:#4e99cf;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\tpushbox ._aimtellPromptDeny{\n\t\t\t\t background-color: #ffffff;\n\t\t\t\t color:#4e99cf;\n\t\t\t\t} \n\t\t\t\t@media only screen and (max-device-width: 720px) and (orientation: landscape){\n\t\t\t\t\tpushbox{\n\t\t\t\t\t\tdisplay:none;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t@media (max-width: 480px){\n\t\t\t\t\t pushboxcontainer{\n\t\t\t\t\t left:0px !important;\n\t\t\t\t\t } \n\t\t\t\t\t \n\t\t\t\t\t pushbox{\n\t\t\t\t\t border-radius: 0px !important;\n\t\t\t\t\t width:initial;\n\t\t\t\t\t position:fixed !important;\n\t\t\t\t\t bottom: 0px !important;\n\t\t\t\t\t min-height:150px;\n\t\t\t\t\t padding-top:10px;\n\t\t\t\t\t box-shadow: none;\n\n\t\t\t\t\t }\n\n\t\t\t\t\t pushbox-cta{\n\t\t\t\t\t \tdisplay:block;\n\t\t\t\t\t \tpadding-top:10px;\n\t\t\t\t\t }\n\n\t\t\t\t\t pushbox teaser, pushbox teaser-byline, pushbox pushbox-cta buttons{\n\t\t\t\t \t\tfont-size:14px;\n\t\t\t\t\t}\n\n\t\t\t\t\n\t\t\t\t\tpushbox noticon img{\n\t\t\t\t\t\twidth:65px;\n\t\t\t\t\t\theight:65px;\n\t\t\t\t\t\tborder:2px solid #E9E9E9;\n\t\t\t\t\t}\n\n\t\t\t\t\tpushbox powered{\n\t\t\t\t\t font-size:10px;\n\t\t\t\t\t margin-top:9px;\n\t\t\t\t\t}\n\n\t\t\t\t}\n\t\t\t\t</style><div id='aimtellPrompt_overlay'><pushboxcontainer id='pushboxcontainer'>\n\t\t\t\t<img style='position:absolute; visibility:hidden' height='0' width='0' src='https://analytics.aimtell.com/prompt-view?id_site=147&prompt_type=3&prompt_id=3793'>\n\t\t\t\t <pushbox>\n\t\t\t\t <pushbox-cta>\n\t\t\t\t <noticon class='_aimtellBell'>\n\t\t\t\t\t\t\t<img src='https://cdn.aimtell.io/user/uploads/147-1588184063.png'>\n\t\t\t\t </noticon>\n\t\t\t\t \n\t\t\t\t <notibody>\n\t\t\t\t <teaser>Want updates?</teaser>\n\t\t\t\t <teaser-byline>Get the latest and greatest</teaser-byline>\n\t\t\t\t </notibody>\n\t\t\t\t <buttons>\n\t\t\t\t \t<powered><a target='_BLANK' href='https://aimtell.com/liked-our-push-notification-widget?domain=website.com&utm_source=aimtell&utm_medium=prompt&utm_campaign=147&utm_content=type-3'><svg enable-background='new 0 0 512 512' version='1.1' viewBox='0 0 512 512' xml:space='preserve' xmlns='http://www.w3.org/2000/svg'><path d='m400.27 175.6c-1.399-3.004-4.412-4.932-7.731-4.932h-101.12l99.797-157.57c1.664-2.628 1.766-5.956 0.265-8.678-1.502-2.731-4.37-4.421-7.476-4.421h-136.53c-3.234 0-6.187 1.826-7.637 4.719l-128 256c-1.323 2.637-1.178 5.777 0.375 8.294 1.562 2.517 4.301 4.053 7.262 4.053h87.748l-95.616 227.09c-1.63 3.883-0.179 8.388 3.413 10.59 1.382 0.845 2.918 1.254 4.446 1.254 2.449 0 4.864-1.05 6.537-3.029l273.07-324.27c2.141-2.542 2.602-6.092 1.203-9.104z'/></svg> by Aimtell</a></powered>\n\t\t\t\t \t<button-approve onclick='_aimtellPromptApprove()' class='_aimtellPromptApprove'>Yes, please</button-approve>\n\t\t\t\t \t <button-deny onclick='_aimtellPromptDeny()' class='_aimtellPromptDeny'>No, thanks</button-deny> \n\t\t\t\t </buttons>\n\t\t\t\t\t\t\n\t\t\t\t </pushbox-cta>\n\t\t\t\t </pushbox>\n\t\t\t\t</pushboxcontainer></div>"