Skip to main content
GET
/
prod
/
prompts
/
{idSite}
Get Opt-in Prompts
curl --request GET \
  --url https://api.aimtell.com/prod/prompts/{idSite} \
  --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": "Not for me",
    "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": null,
    "prompt_type": 3,
    "prompt_position": null,
    "prompt_sticky": 0,
    "createdAt": "2020-04-29 18:13:33",
    "updatedAt": "2020-07-28 18:39:51"
  },
  {
    "id": 234,
    "uid": "12abcd3456e7",
    "idSite": 20599,
    "name": "Safari Prompt",
    "header_text": "Hi there!",
    "header_text_color": "#000000",
    "body_text": "Would you like to receive notifications on deals and sales?",
    "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/siteicons.aimtell.com/icon_147_1588190286.png",
    "prompt_color": null,
    "prompt_type": 3,
    "prompt_position": null,
    "prompt_sticky": 0,
    "createdAt": "2020-06-01 14:45:55",
    "updatedAt": "2020-06-01 14:46:29"
  },
  {
    "id": 456,
    "uid": "12abcd3456e7",
    "idSite": 147,
    "name": "Prompt 2",
    "header_text": "",
    "header_text_color": "#000000",
    "body_text": "Would you like to receive the latest updates?",
    "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/siteicons.aimtell.com/icon_147_1588190286.png",
    "prompt_color": null,
    "prompt_type": 1,
    "prompt_position": null,
    "prompt_sticky": 0,
    "createdAt": "2020-07-15 16:46:18",
    "updatedAt": "2020-07-22 19:26:52"
  }
]

Authorizations

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

Path Parameters

​
idSite
string
required

Website ID

Response

200

​
id
integer
default:0
Example:

123

​
uid
string
Example:

"12abcd3456e7"

​
idSite
integer
default:0
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:

"Not for me"

​
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
integer
default:0
Example:

1

​
icon_url
string
Example:

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

​
prompt_color
any
​
prompt_type
integer
default:0
Example:

3

​
prompt_position
any
​
prompt_sticky
integer
default:0
Example:

0

​
createdAt
string
Example:

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

​
updatedAt
string
Example:

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