/
v3.0.11Get access

getPopup

Retrieve detailed information about a single popup by its ID

Request parameters:

Name
DescriptionTypeValuesDefault
popupId
The unique identifier of the popupnumber--
country
Country code used for global filteringstring--
platform
Platform namestring"desktop" / "mobile"-

Call example:

getPopup({
  popupId: 25,
  country: 'AM',
  platform: 'desktop'
})

Response parameters:

NameDescriptionTypeValues
id
Auto-increment unique identifier of the popupnumber-
show_to
Visibility scope: 0 = all, 1 = authorized users only, 2 = guests onlynumber-
target
Link target attribute: "_blank", "_self", "_parent", or "_top"string-
repeat_time
Number of times the popup can be repeatednumber-
show_on_pages
List of page slugs the popup should appear onarray-
show_on_page
Primary page slug the popup is assigned tostring-
type
Popup trigger type: "after_registration", "per_page", "after_bet", or "crm"string-
show_on_type
Display type identifier controlling how the popup is shownnumber-
archived_at
Timestamp when the popup was archived, or null if still activestring | null-
title
Display title of the popupstring-
content
HTML content body of the popupstring-
href
URL the popup links to when clickedstring-
profile_types
List of restricted profile types. Empty array means no restrictionarray-
profile_status
Required profile status for the popup to be shownnumber-
custom_profile_types
List of custom profile type restrictionsarray-
profile_action_type
Profile action type condition required to trigger the popupnumber-
deposit_type
Deposit type condition required to trigger the popupnumber-
first_deposit
Whether the popup is restricted to first deposit only (0 = no, 1 = yes)number-