Campaign notifications

Retrieve all

GET https://flash.realzrealz.com/api/notifications/
curl --request GET \
--url 'https://flash.realzrealz.com/api/notifications/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25.
{ "data": [ { "id": 1, "campaign_id": 1, "notification_key": "d4752d29a557a9fdc67b0a9a27cbe3b1", "name": "Email Collector", "type": "EMAIL_COLLECTOR", "settings": { ... }, "is_enabled": false, "last_datetime": null, "datetime": "2025-10-31 12:47:38" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://flash.realzrealz.com/api/notifications?&page=1", "last": "https://flash.realzrealz.com/api/notifications?&page=1", "next": null, "prev": null, "self": "https://flash.realzrealz.com/api/notifications?&page=1" } }

Retrieve one

GET https://flash.realzrealz.com/api/notifications/{notification_id}
curl --request GET \
--url 'https://flash.realzrealz.com/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "campaign_id": 1, "notification_key": "d4752d29a557a9fdc67b0a9a27cbe3b1", "name": "Email Collector", "type": "EMAIL_COLLECTOR", "settings": { ... }, "is_enabled": false, "last_datetime": null, "datetime": "2025-10-31 12:47:38" } }

Create

POST https://flash.realzrealz.com/api/notifications
Parameters Details Description
campaign_id Required Integer -
type Required String Allowed values: BANNER , VIDEO , VIDEO_WITH_BUTTON , BUTTON_MODAL , IMAGE , AUDIO , CONVERSIONS , INFORMATIONAL , COOKIE_NOTIFICATION , CONVERSIONS_COUNTER , LIVE_COUNTER , REVIEWS , INFORMATIONAL_BAR_MINI , BUTTON_BAR , INFORMATIONAL_MINI , INFORMATIONAL_BAR , COUNTDOWN_COLLECTOR , EMAIL_COLLECTOR , COLLECTOR_BAR , COLLECTOR_MODAL , COLLECTOR_TWO_MODAL , COUPON , COUPON_WITH_BUTTON , COUPON_BAR , WHATSAPP_CHAT , CONTACT_US , SOCIAL_SHARE , REQUEST_COLLECTOR , ENGAGEMENT_LINKS , EMOJI_FEEDBACK , TEXT_FEEDBACK , SCORE_FEEDBACK
name Optional String -
is_enabled Optional Boolean -
curl --request POST \
--url 'https://flash.realzrealz.com/api/notifications' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'type=INFORMATIONAL' \
--form 'is_enabled=1'
{ "data": { "id": 1 } }

Update

POST https://flash.realzrealz.com/api/notifications/{notification_id}
Parameters Details Description
name Optional String -
is_enabled Optional Boolean -
trigger_all_pages Optional Boolean -
display_trigger Optional String Allowed values: delay, time_on_site, pageviews, inactivity, exit_intent, scroll, click, hover
display_value Optional String -
display_delay_type_after_close Optional String Allowed values: time_on_site, pageviews
display_delay_value_after_close Optional Integer -
display_frequency Optional String Allowed values: all_time, once_per_session, once_per_browser
direction Optional String Allowed values: rtl, ltr
display_continents Optional Array String -
display_countries Optional Array String -
display_languages Optional Array String -
display_operating_systems Optional Array String -
display_browsers Optional Array String -
display_cities Optional Array String -
display_mobile Optional Boolean -
display_desktop Optional Boolean -
schedule Optional Boolean -
start_date Optional String -
end_date Optional String -
display_duration Optional Integer -
display_position Optional String Allowed values: top_left, top_center, top_right, middle_left, middle_center, middle_right, bottom_left, bottom_center, bottom_right, top, bottom, top_floating, bottom_floating
display_close_button Optional Boolean -
display_branding Optional Boolean -
shadow Optional String Allowed values: , subtle, feather, 3d, layered
border_width Optional Integer Allowed values: 0, 1, 2, 3, 4, 5
internal_padding Optional Integer Allowed values: 5-25
background_blur Optional Integer Allowed values: 0-30
custom_css Optional String -
hover_animation Optional String Allowed values: , fast_scale_up, slow_scale_up, fast_scale_down, slow_scale_down
on_animation Optional String Allowed values: fadeIn, slideInUp, slideInDown, zoomIn, bounceIn
off_animation Optional String Allowed values: fadeOut, slideOutUp, slideOutDown, zoomOut, bounceOut
animation Optional String Allowed values: , heartbeat, bounce, flash, pulse
animation_interval Optional Integer -
font Optional String Allowed values: inherit, Arial, Verdana, Helvetica, Tahoma, Trebuchet MS, Times New Roman, Georgia, Courier New, Monaco, Comic Sans MS, Courier, Impact, Futura, Luminari, Baskerville, Papyrus
border_radius Optional String Allowed values: straight, rounded, highly_rounded, round
notifications Optional Array Available when: type = email_collector, collector_bar, collector_modal, collector_two_modal, conversions, conversions_counter, countdown_collector, request_collector, text_feedback Notification handler ids
informational
title Optional String Available when: type = informational
description Optional String Available when: type = informational
image Optional File Available when: type = informational
image_alt Optional String Available when: type = informational
url Optional String Available when: type = informational
url_new_tab Optional Boolean Available when: type = informational
title_color Optional String Available when: type = informational
description_color Optional String Available when: type = informational
background_color Optional String Available when: type = informational
informational_mini
title Optional String Available when: type = informational_mini
image Optional File Available when: type = informational_mini
image_alt Optional String Available when: type = informational_mini
url Optional String Available when: type = informational_mini
url_new_tab Optional Boolean Available when: type = informational_mini
title_color Optional String Available when: type = informational_mini
description_color Optional String Available when: type = informational_mini
background_color Optional String Available when: type = informational_mini
coupon
title Optional String Available when: type = coupon
description Optional String Available when: type = coupon
image Optional File Available when: type = coupon
image_alt Optional String Available when: type = coupon
coupon_code Optional String Available when: type = coupon
button_url Optional String Available when: type = coupon
url_new_tab Optional Boolean Available when: type = coupon
button_text Optional String Available when: type = coupon
title_color Optional String Available when: type = coupon
description_color Optional String Available when: type = coupon
background_color Optional String Available when: type = coupon
button_background_color Optional String Available when: type = coupon
button_color Optional String Available when: type = coupon
live_counter
description Optional String Available when: type = live_counter
last_activity Optional String Available when: type = live_counter
url Optional String Available when: type = live_counter
url_new_tab Optional Boolean Available when: type = live_counter
display_minimum_activity Optional Integer Available when: type = live_counter
description_color Optional String Available when: type = live_counter
background_color Optional String Available when: type = live_counter
number_background_color Optional String Available when: type = live_counter
number_color Optional String Available when: type = live_counter
pulse_background_color Optional String Available when: type = live_counter
email_collector
conversions
title Optional String Available when: type = conversions
description Optional String Available when: type = conversions
image Optional File Available when: type = conversions
image_alt Optional String Available when: type = conversions
url Optional String Available when: type = conversions
display_time Optional Boolean Available when: type = conversions
url_new_tab Optional Boolean Available when: type = conversions
conversions_count Optional Integer Available when: type = conversions
in_between_delay Optional Integer Available when: type = conversions
order Optional String Available when: type = conversions
Allowed values: random, descending
data_trigger_auto Optional Boolean Available when: type = conversions
data_trigger_auto_type[index] Optional Array String Available when: type = conversions
Allowed values: exact , contains , starts_with , ends_with
data_trigger_auto_value[index] Optional Array String Available when: type = conversions
title_color Optional String Available when: type = conversions
description_color Optional String Available when: type = conversions
date_color Optional String Available when: type = conversions
background_color Optional String Available when: type = conversions
conversions counter
title Optional String Available when: type = conversions counter
last_activity Optional String Available when: type = conversions counter
url Optional String Available when: type = conversions counter
url_new_tab Optional Boolean Available when: type = conversions counter
display_minimum_activity Optional String Available when: type = conversions counter
title_color Optional String Available when: type = conversions counter
background_color Optional String Available when: type = conversions counter
number_background_color Optional String Available when: type = conversions counter
number_color Optional String Available when: type = conversions counter
data_trigger_auto Optional Boolean Available when: type = conversions counter
data_trigger_auto_type[index] Optional Array String Available when: type = conversions
Allowed values: exact , contains , starts_with , ends_with
data_trigger_auto_value[index] Optional Array String Available when: type = conversions
video
title Optional String Available when: type = video
video Optional File Available when: type = video
video_is_youtube Optional Boolean Available when: type = video
youtube_video_id Optional String Available when: type = video
video_autoplay Optional Boolean Available when: type = video
video_controls Optional Boolean Available when: type = video
video_loop Optional Boolean Available when: type = video
video_muted Optional Boolean Available when: type = video
button_url Optional String Available when: type = video
button_text Optional String Available when: type = video
url_new_tab Optional Boolean Available when: type = video
title_color Optional String Available when: type = video
background_color Optional String Available when: type = video
button_background_color Optional String Available when: type = video
button_color Optional String Available when: type = video
audio
title Optional String Available when: type = audio
audio Optional File Available when: type = audio
audio_autoplay Optional Boolean Available when: type = audio
audio_controls Optional Boolean Available when: type = audio
audio_loop Optional Boolean Available when: type = audio
audio_muted Optional Boolean Available when: type = audio
button_url Optional String Available when: type = audio
button_text Optional String Available when: type = audio
url_new_tab Optional Boolean Available when: type = audio
title_color Optional String Available when: type = audio
background_color Optional String Available when: type = audio
button_background_color Optional String Available when: type = audio
button_color Optional String Available when: type = audio
social_share
reviews
url Optional String Available when: type = reviews
url_new_tab Optional Boolean Available when: type = reviews
reviews_count Optional api_documentation.integer Available when: type = reviews
in_between_delay Optional api_documentation.integer Available when: type = reviews
order Optional String Available when: type = reviews
title api_documentation.default String Available when: type = reviews
description api_documentation.default String Available when: type = reviews
image api_documentation.default File Available when: type = reviews
stars api_documentation.default api_documentation.integer Available when: type = reviews
title_color Optional String Available when: type = reviews
description_color Optional String Available when: type = reviews
background_color Optional String Available when: type = reviews
emoji_feedback
title Optional String Available when: type = emoji_feedback
thank_you_url Optional String Available when: type = emoji_feedback
show_angry Optional Boolean Available when: type = emoji_feedback
show_sad Optional Boolean Available when: type = emoji_feedback
show_neutral Optional Boolean Available when: type = emoji_feedback
show_happy Optional Boolean Available when: type = emoji_feedback
show_excited Optional Boolean Available when: type = emoji_feedback
title_color Optional String Available when: type = emoji_feedback
background_color Optional String Available when: type = emoji_feedback
cookie_notification
description Optional String Available when: type = cookie_notification
image Optional File Available when: type = cookie_notification
image_alt Optional Float Available when: type = cookie_notification
url_text Optional String Available when: type = cookie_notification
url Optional String Available when: type = cookie_notification
button_text Optional String Available when: type = cookie_notification
description_color Optional String Available when: type = cookie_notification
background_color Optional String Available when: type = cookie_notification
button_background_color Optional String Available when: type = cookie_notification
button_color Optional String Available when: type = cookie_notification
score_feedback
title Optional String Available when: type = score_feedback
description Optional String Available when: type = score_feedback
thank_you_url Optional String Available when: type = score_feedback
title_color Optional String Available when: type = score_feedback
description_color Optional String Available when: type = score_feedback
background_color Optional String Available when: type = score_feedback
button_background_color Optional String Available when: type = score_feedback
button_color Optional String Available when: type = score_feedback
request_collector
title Optional String Available when: type = request_collector
description Optional String Available when: type = request_collector
image Optional File Available when: type = request_collector
image_alt Optional String Available when: type = request_collector
content_title Optional String Available when: type = request_collector
content_description Optional String Available when: type = request_collector
input_placeholder Optional String Available when: type = request_collector
button_text Optional String Available when: type = request_collector
show_agreement Optional Boolean Available when: type = request_collector
agreement_text Optional String Available when: type = request_collector
agreement_url Optional String Available when: type = request_collector
thank_you_url Optional String Available when: type = request_collector
title_color Optional String Available when: type = request_collector
description_color Optional String Available when: type = request_collector
content_title_color Optional String Available when: type = request_collector
content_description_color Optional String Available when: type = request_collector
background_color Optional String Available when: type = request_collector
button_background_color Optional String Available when: type = request_collector
button_color Optional String Available when: type = request_collector
countdown_collector
title Optional String Available when: type = countdown_collector
description Optional String Available when: type = countdown_collector
content_title Optional String Available when: type = countdown_collector
input_placeholder Optional String Available when: type = countdown_collector
button_text Optional String Available when: type = countdown_collector
countdown_end_date Optional String Available when: type = countdown_collector
show_agreement Optional Boolean Available when: type = countdown_collector
agreement_text Optional String Available when: type = countdown_collector
agreement_url Optional String Available when: type = countdown_collector
thank_you_url Optional String Available when: type = countdown_collector
title_color Optional String Available when: type = countdown_collector
description_color Optional String Available when: type = countdown_collector
content_title_color Optional String Available when: type = countdown_collector
time_color Optional String Available when: type = countdown_collector
time_background_color Optional String Available when: type = countdown_collector
background_color Optional String Available when: type = countdown_collector
button_background_color Optional String Available when: type = countdown_collector
button_color Optional String Available when: type = countdown_collector
custom_html
html Optional String Available when: type = custom_html
background_color Optional String Available when: type = custom_html
informational_bar
title Optional String Available when: type = informational_bar
description Optional String Available when: type = informational_bar
image Optional File Available when: type = informational_bar
image_alt Optional Float Available when: type = informational_bar
url Optional Float Available when: type = informational_bar
url_new_tab Optional Boolean Available when: type = informational_bar
title_color Optional String Available when: type = informational_bar
description_color Optional String Available when: type = informational_bar
background_color Optional String Available when: type = informational_bar
informational_bar_mini
title Optional String Available when: type = informational_bar_mini
image Optional File Available when: type = informational_bar_mini
image_alt Optional Float Available when: type = informational_bar_mini
url Optional Float Available when: type = informational_bar_mini
url_new_tab Optional Boolean Available when: type = informational_bar_mini
title_color Optional String Available when: type = informational_bar_mini
description_color Optional String Available when: type = informational_bar_mini
background_color Optional String Available when: type = informational_bar_mini
image
title Optional String Available when: type = image
image Optional File Available when: type = image
image_alt Optional String Available when: type = image
button_url Optional String Available when: type = image
button_text Optional String Available when: type = image
title_color Optional String Available when: type = image
background_color Optional String Available when: type = image
button_background_color Optional String Available when: type = image
button_color Optional String Available when: type = image
collector_bar
title Optional String Available when: type = collector_bar
input_placeholder Optional String Available when: type = collector_bar
button_text Optional String Available when: type = collector_bar
show_agreement Optional Boolean Available when: type = collector_bar
agreement_text Optional String Available when: type = collector_bar
agreement_url Optional String Available when: type = collector_bar
thank_you_url Optional String Available when: type = collector_bar
title_color Optional String Available when: type = collector_bar
background_color Optional String Available when: type = collector_bar
button_background_color Optional String Available when: type = collector_bar
button_color Optional String Available when: type = collector_bar
coupon_bar
title Optional String Available when: type = coupon_bar
coupon_code Optional String Available when: type = coupon_bar
url Optional Float Available when: type = coupon_bar
url_new_tab Optional Boolean Available when: type = coupon_bar
title_color Optional String Available when: type = coupon_bar
background_color Optional String Available when: type = coupon_bar
coupon_code_color Optional String Available when: type = coupon_bar
coupon_code_background_color Optional String Available when: type = coupon_bar
coupon_code_border_color Optional String Available when: type = coupon_bar
button_bar
title Optional String Available when: type = button_bar
button_text Optional String Available when: type = button_bar
url Optional String Available when: type = button_bar
url_new_tab Optional Boolean Available when: type = button_bar
title_color Optional String Available when: type = button_bar
background_color Optional String Available when: type = button_bar
button_color Optional String Available when: type = button_bar
button_background_color Optional String Available when: type = button_bar
collector_modal
title Optional String Available when: type = collector_modal
description Optional String Available when: type = collector_modal
image Optional File Available when: type = collector_modal
image_alt Optional String Available when: type = collector_modal
input_placeholder Optional String Available when: type = collector_modal
button_text Optional String Available when: type = collector_modal
show_agreement Optional Boolean Available when: type = collector_modal
agreement_text Optional String Available when: type = collector_modal
agreement_url Optional String Available when: type = collector_modal
thank_you_url Optional String Available when: type = collector_modal
title_color Optional String Available when: type = collector_modal
description_color Optional String Available when: type = collector_modal
background_color Optional String Available when: type = collector_modal
button_background_color Optional String Available when: type = collector_modal
button_color Optional String Available when: type = collector_modal
collector_two_modal
title Optional String Available when: type = collector_two_modal
description Optional String Available when: type = collector_two_modal
image Optional File Available when: type = collector_two_modal
image_alt Optional String Available when: type = collector_two_modal
input_placeholder Optional String Available when: type = collector_two_modal
button_text Optional String Available when: type = collector_two_modal
show_agreement Optional Boolean Available when: type = collector_two_modal
agreement_text Optional String Available when: type = collector_two_modal
agreement_url Optional String Available when: type = collector_two_modal
thank_you_url Optional String Available when: type = collector_two_modal
title_color Optional String Available when: type = collector_two_modal
description_color Optional String Available when: type = collector_two_modal
background_color Optional String Available when: type = collector_two_modal
button_background_color Optional String Available when: type = collector_two_modal
button_color Optional String Available when: type = collector_two_modal
button_modal
title Optional String Available when: type = button_modal
description Optional String Available when: type = button_modal
image Optional File Available when: type = button_modal
image_alt Optional String Available when: type = button_modal
button_text Optional String Available when: type = button_modal
button_url Optional String Available when: type = button_modal
url_new_tab Optional Boolean Available when: type = button_modal
title_color Optional String Available when: type = button_modal
description_color Optional String Available when: type = button_modal
background_color Optional String Available when: type = button_modal
button_background_color Optional String Available when: type = button_modal
button_color Optional String Available when: type = button_modal
text_feedback
title Optional String Available when: type = text_feedback
description Optional String Available when: type = text_feedback
input_placeholder Optional String Available when: type = text_feedback
button_text Optional String Available when: type = text_feedback
thank_you_url Optional String Available when: type = text_feedback
title_color Optional String Available when: type = text_feedback
description_color Optional String Available when: type = text_feedback
background_color Optional String Available when: type = text_feedback
button_background_color Optional String Available when: type = text_feedback
button_color Optional String Available when: type = text_feedback
engagement_links
title_color Optional String Available when: type = text_feedback
categories_title_color Optional String Available when: type = text_feedback
categories_description_color Optional String Available when: type = text_feedback
categories_links_title_color Optional String Available when: type = text_feedback
categories_links_description_color Optional String Available when: type = text_feedback
categories_links_background_color Optional String Available when: type = text_feedback
categories_links_border_color Optional String Available when: type = text_feedback
background_color Optional String Available when: type = text_feedback
whatsapp_chat
title Optional String Available when: type = whatsapp_chat
agent_image Optional File Available when: type = whatsapp_chat
agent_image_alt Optional String Available when: type = whatsapp_chat
agent_name Optional String Available when: type = whatsapp_chat
agent_description Optional String Available when: type = whatsapp_chat
agent_message Optional String Available when: type = whatsapp_chat
agent_phone_number Optional String Available when: type = whatsapp_chat
button_text Optional String Available when: type = whatsapp_chat
header_agent_name_color Optional String Available when: type = whatsapp_chat
header_agent_description_color Optional String Available when: type = whatsapp_chat
header_background_color Optional String Available when: type = whatsapp_chat
content_background_color Optional String Available when: type = whatsapp_chat
content_agent_name_color Optional String Available when: type = whatsapp_chat
content_agent_message_color Optional String Available when: type = whatsapp_chat
content_agent_message_background_color Optional String Available when: type = whatsapp_chat
footer_background_color Optional String Available when: type = whatsapp_chat
footer_button_background_color Optional String Available when: type = whatsapp_chat
footer_button_color Optional String Available when: type = whatsapp_chat
title_color Optional String Available when: type = whatsapp_chat
background_color Optional String Available when: type = whatsapp_chat
contact_us
title Optional String Available when: type = contact_us
description Optional String Available when: type = contact_us
contact_email Optional String Available when: type = contact_us
contact_phone_number Optional String Available when: type = contact_us
contact_whatsapp Optional String Available when: type = contact_us
contact_telegram Optional String Available when: type = contact_us
contact_facebook_messenger Optional String Available when: type = contact_us
title_color Optional String Available when: type = contact_us
description_color Optional String Available when: type = contact_us
background_color Optional String Available when: type = contact_us
curl --request POST \
--url 'https://flash.realzrealz.com/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=example' \
--form 'is_enabled=1'
{ "data": { "id": 1 } }

Delete

DELETE https://flash.realzrealz.com/api/notifications/{notification_id}
curl --request DELETE \
--url 'https://flash.realzrealz.com/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \