キャンペーンのお知らせ

すべてを取得

GET https://popupke.com/api/notifications/
curl --request GET \
--url 'https://popupke.com/api/notifications/' \
--header 'Authorization: Bearer {api_key}' \
パラメーター 詳細 説明
page オプション 整数 The page number that you want results from. Defaults to 1.
results_per_page オプション 整数 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-04-25 00:59:31" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://popupke.com/api/notifications?&page=1", "last": "https://popupke.com/api/notifications?&page=1", "next": null, "prev": null, "self": "https://popupke.com/api/notifications?&page=1" } }

1 つ取得する

GET https://popupke.com/api/notifications/{notification_id}
curl --request GET \
--url 'https://popupke.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-04-25 00:59:31" } }

作成する

POST https://popupke.com/api/notifications
パラメーター 詳細 説明
campaign_id 必須 整数 -
type 必須 弦 Allowed values: INFORMATIONAL , COUPON , LIVE_COUNTER , EMAIL_COLLECTOR , CONVERSIONS , CONVERSIONS_COUNTER , VIDEO , AUDIO , SOCIAL_SHARE , REVIEWS , EMOJI_FEEDBACK , COOKIE_NOTIFICATION , SCORE_FEEDBACK , REQUEST_COLLECTOR , COUNTDOWN_COLLECTOR , CUSTOM_HTML , INFORMATIONAL_BAR , IMAGE , COLLECTOR_BAR , COUPON_BAR , BUTTON_BAR , COLLECTOR_MODAL , COLLECTOR_TWO_MODAL , BUTTON_MODAL , TEXT_FEEDBACK , ENGAGEMENT_LINKS , WHATSAPP_CHAT , CONTACT_US , INFORMATIONAL_MINI , INFORMATIONAL_BAR_MINI
name オプション 弦 -
is_enabled オプション ブール値 -
curl --request POST \
--url 'https://popupke.com/api/notifications' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'type=INFORMATIONAL' \
--form 'is_enabled=1'
{ "data": { "id": 1 } }

アップデート

POST https://popupke.com/api/notifications/{notification_id}
パラメーター 詳細 説明
name オプション 弦 -
is_enabled オプション ブール値 -
trigger_all_pages オプション ブール値 -
display_trigger オプション 弦 Allowed values: delay, time_on_site, pageviews, inactivity, exit_intent, scroll, click, hover
display_value オプション 弦 -
display_delay_type_after_close オプション 弦 Allowed values: time_on_site, pageviews
display_delay_value_after_close オプション 整数 -
display_frequency オプション 弦 Allowed values: all_time, once_per_session, once_per_browser
direction オプション 弦 Allowed values: rtl, ltr
display_continents オプション 配列 弦 -
display_countries オプション 配列 弦 -
display_languages オプション 配列 弦 -
display_operating_systems オプション 配列 弦 -
display_browsers オプション 配列 弦 -
display_cities オプション 配列 弦 -
display_mobile オプション ブール値 -
display_desktop オプション ブール値 -
schedule オプション ブール値 -
start_date オプション 弦 -
end_date オプション 弦 -
display_duration オプション 整数 -
display_position オプション 弦 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 オプション ブール値 -
display_branding オプション ブール値 -
shadow オプション 弦 Allowed values: , subtle, feather, 3d, layered
border_width オプション 整数 Allowed values: 0, 1, 2, 3, 4, 5
internal_padding オプション 整数 Allowed values: 5-25
background_blur オプション 整数 Allowed values: 0-30
custom_css オプション 弦 -
hover_animation オプション 弦 Allowed values: , fast_scale_up, slow_scale_up, fast_scale_down, slow_scale_down
on_animation オプション 弦 Allowed values: fadeIn, slideInUp, slideInDown, zoomIn, bounceIn
off_animation オプション 弦 Allowed values: fadeOut, slideOutUp, slideOutDown, zoomOut, bounceOut
animation オプション 弦 Allowed values: , heartbeat, bounce, flash, pulse
animation_interval オプション 整数 -
font オプション 弦 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, Brush Script MT
border_radius オプション 弦 Allowed values: straight, rounded, highly_rounded, round
notifications オプション 配列 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 オプション 弦 Available when: type = informational
description オプション 弦 Available when: type = informational
image オプション ファイル Available when: type = informational
image_alt オプション 弦 Available when: type = informational
url オプション 弦 Available when: type = informational
url_new_tab オプション ブール値 Available when: type = informational
title_color オプション 弦 Available when: type = informational
description_color オプション 弦 Available when: type = informational
background_color オプション 弦 Available when: type = informational
informational_mini
title オプション 弦 Available when: type = informational_mini
image オプション ファイル Available when: type = informational_mini
image_alt オプション 弦 Available when: type = informational_mini
url オプション 弦 Available when: type = informational_mini
url_new_tab オプション ブール値 Available when: type = informational_mini
title_color オプション 弦 Available when: type = informational_mini
description_color オプション 弦 Available when: type = informational_mini
background_color オプション 弦 Available when: type = informational_mini
coupon
title オプション 弦 Available when: type = coupon
description オプション 弦 Available when: type = coupon
image オプション ファイル Available when: type = coupon
image_alt オプション 弦 Available when: type = coupon
coupon_code オプション 弦 Available when: type = coupon
button_url オプション 弦 Available when: type = coupon
url_new_tab オプション ブール値 Available when: type = coupon
button_text オプション 弦 Available when: type = coupon
title_color オプション 弦 Available when: type = coupon
description_color オプション 弦 Available when: type = coupon
background_color オプション 弦 Available when: type = coupon
button_background_color オプション 弦 Available when: type = coupon
button_color オプション 弦 Available when: type = coupon
live_counter
description オプション 弦 Available when: type = live_counter
last_activity オプション 弦 Available when: type = live_counter
url オプション 弦 Available when: type = live_counter
url_new_tab オプション ブール値 Available when: type = live_counter
display_minimum_activity オプション 整数 Available when: type = live_counter
description_color オプション 弦 Available when: type = live_counter
background_color オプション 弦 Available when: type = live_counter
number_background_color オプション 弦 Available when: type = live_counter
number_color オプション 弦 Available when: type = live_counter
pulse_background_color オプション 弦 Available when: type = live_counter
email_collector
conversions
title オプション 弦 Available when: type = conversions
description オプション 弦 Available when: type = conversions
image オプション ファイル Available when: type = conversions
image_alt オプション 弦 Available when: type = conversions
url オプション 弦 Available when: type = conversions
url_new_tab オプション ブール値 Available when: type = conversions
conversions_count オプション 整数 Available when: type = conversions
in_between_delay オプション 整数 Available when: type = conversions
order オプション 弦 Available when: type = conversions
Allowed values: random, descending
data_trigger_auto オプション ブール値 Available when: type = conversions
data_trigger_auto_type[index] オプション 配列 弦 Available when: type = conversions
Allowed values: exact , contains , starts_with , ends_with
data_trigger_auto_value[index] オプション 配列 弦 Available when: type = conversions
title_color オプション 弦 Available when: type = conversions
description_color オプション 弦 Available when: type = conversions
date_color オプション 弦 Available when: type = conversions
background_color オプション 弦 Available when: type = conversions
conversions counter
title オプション 弦 Available when: type = conversions counter
last_activity オプション 弦 Available when: type = conversions counter
url オプション 弦 Available when: type = conversions counter
url_new_tab オプション ブール値 Available when: type = conversions counter
display_minimum_activity オプション 弦 Available when: type = conversions counter
title_color オプション 弦 Available when: type = conversions counter
background_color オプション 弦 Available when: type = conversions counter
number_background_color オプション 弦 Available when: type = conversions counter
number_color オプション 弦 Available when: type = conversions counter
data_trigger_auto オプション ブール値 Available when: type = conversions counter
data_trigger_auto_type[index] オプション 配列 弦 Available when: type = conversions
Allowed values: exact , contains , starts_with , ends_with
data_trigger_auto_value[index] オプション 配列 弦 Available when: type = conversions
video
title オプション 弦 Available when: type = video
video オプション ファイル Available when: type = video
video_is_youtube オプション ブール値 Available when: type = video
youtube_video_id オプション 弦 Available when: type = video
video_autoplay オプション ブール値 Available when: type = video
video_controls オプション ブール値 Available when: type = video
video_loop オプション ブール値 Available when: type = video
video_muted オプション ブール値 Available when: type = video
button_url オプション 弦 Available when: type = video
button_text オプション 弦 Available when: type = video
url_new_tab オプション ブール値 Available when: type = video
title_color オプション 弦 Available when: type = video
background_color オプション 弦 Available when: type = video
button_background_color オプション 弦 Available when: type = video
button_color オプション 弦 Available when: type = video
audio
title オプション 弦 Available when: type = audio
audio オプション ファイル Available when: type = audio
audio_autoplay オプション ブール値 Available when: type = audio
audio_controls オプション ブール値 Available when: type = audio
audio_loop オプション ブール値 Available when: type = audio
audio_muted オプション ブール値 Available when: type = audio
button_url オプション 弦 Available when: type = audio
button_text オプション 弦 Available when: type = audio
url_new_tab オプション ブール値 Available when: type = audio
title_color オプション 弦 Available when: type = audio
background_color オプション 弦 Available when: type = audio
button_background_color オプション 弦 Available when: type = audio
button_color オプション 弦 Available when: type = audio
social_share
reviews
url オプション 弦 Available when: type = reviews
url_new_tab オプション ブール値 Available when: type = reviews
reviews_count オプション missing_translation: api_documentation.integer Available when: type = reviews
in_between_delay オプション missing_translation: api_documentation.integer Available when: type = reviews
order オプション 弦 Available when: type = reviews
title missing_translation: api_documentation.default 弦 Available when: type = reviews
description missing_translation: api_documentation.default 弦 Available when: type = reviews
image missing_translation: api_documentation.default ファイル Available when: type = reviews
stars missing_translation: api_documentation.default missing_translation: api_documentation.integer Available when: type = reviews
title_color オプション 弦 Available when: type = reviews
description_color オプション 弦 Available when: type = reviews
background_color オプション 弦 Available when: type = reviews
emoji_feedback
title オプション 弦 Available when: type = emoji_feedback
thank_you_url オプション 弦 Available when: type = emoji_feedback
show_angry オプション ブール値 Available when: type = emoji_feedback
show_sad オプション ブール値 Available when: type = emoji_feedback
show_neutral オプション ブール値 Available when: type = emoji_feedback
show_happy オプション ブール値 Available when: type = emoji_feedback
show_excited オプション ブール値 Available when: type = emoji_feedback
title_color オプション 弦 Available when: type = emoji_feedback
background_color オプション 弦 Available when: type = emoji_feedback
cookie_notification
description オプション 弦 Available when: type = cookie_notification
image オプション ファイル Available when: type = cookie_notification
image_alt オプション 浮く Available when: type = cookie_notification
url_text オプション 弦 Available when: type = cookie_notification
url オプション 弦 Available when: type = cookie_notification
button_text オプション 弦 Available when: type = cookie_notification
description_color オプション 弦 Available when: type = cookie_notification
background_color オプション 弦 Available when: type = cookie_notification
button_background_color オプション 弦 Available when: type = cookie_notification
button_color オプション 弦 Available when: type = cookie_notification
score_feedback
title オプション 弦 Available when: type = score_feedback
description オプション 弦 Available when: type = score_feedback
thank_you_url オプション 弦 Available when: type = score_feedback
title_color オプション 弦 Available when: type = score_feedback
description_color オプション 弦 Available when: type = score_feedback
background_color オプション 弦 Available when: type = score_feedback
button_background_color オプション 弦 Available when: type = score_feedback
button_color オプション 弦 Available when: type = score_feedback
request_collector
title オプション 弦 Available when: type = request_collector
description オプション 弦 Available when: type = request_collector
image オプション ファイル Available when: type = request_collector
image_alt オプション 弦 Available when: type = request_collector
content_title オプション 弦 Available when: type = request_collector
content_description オプション 弦 Available when: type = request_collector
input_placeholder オプション 弦 Available when: type = request_collector
button_text オプション 弦 Available when: type = request_collector
show_agreement オプション ブール値 Available when: type = request_collector
agreement_text オプション 弦 Available when: type = request_collector
agreement_url オプション 弦 Available when: type = request_collector
thank_you_url オプション 弦 Available when: type = request_collector
title_color オプション 弦 Available when: type = request_collector
description_color オプション 弦 Available when: type = request_collector
content_title_color オプション 弦 Available when: type = request_collector
content_description_color オプション 弦 Available when: type = request_collector
background_color オプション 弦 Available when: type = request_collector
button_background_color オプション 弦 Available when: type = request_collector
button_color オプション 弦 Available when: type = request_collector
countdown_collector
title オプション 弦 Available when: type = countdown_collector
description オプション 弦 Available when: type = countdown_collector
content_title オプション 弦 Available when: type = countdown_collector
input_placeholder オプション 弦 Available when: type = countdown_collector
button_text オプション 弦 Available when: type = countdown_collector
countdown_end_date オプション 弦 Available when: type = countdown_collector
show_agreement オプション ブール値 Available when: type = countdown_collector
agreement_text オプション 弦 Available when: type = countdown_collector
agreement_url オプション 弦 Available when: type = countdown_collector
thank_you_url オプション 弦 Available when: type = countdown_collector
title_color オプション 弦 Available when: type = countdown_collector
description_color オプション 弦 Available when: type = countdown_collector
content_title_color オプション 弦 Available when: type = countdown_collector
time_color オプション 弦 Available when: type = countdown_collector
time_background_color オプション 弦 Available when: type = countdown_collector
background_color オプション 弦 Available when: type = countdown_collector
button_background_color オプション 弦 Available when: type = countdown_collector
button_color オプション 弦 Available when: type = countdown_collector
custom_html
html オプション 弦 Available when: type = custom_html
background_color オプション 弦 Available when: type = custom_html
informational_bar
title オプション 弦 Available when: type = informational_bar
description オプション 弦 Available when: type = informational_bar
image オプション ファイル Available when: type = informational_bar
image_alt オプション 浮く Available when: type = informational_bar
url オプション 浮く Available when: type = informational_bar
url_new_tab オプション ブール値 Available when: type = informational_bar
title_color オプション 弦 Available when: type = informational_bar
description_color オプション 弦 Available when: type = informational_bar
background_color オプション 弦 Available when: type = informational_bar
informational_bar_mini
title オプション 弦 Available when: type = informational_bar_mini
image オプション ファイル Available when: type = informational_bar_mini
image_alt オプション 浮く Available when: type = informational_bar_mini
url オプション 浮く Available when: type = informational_bar_mini
url_new_tab オプション ブール値 Available when: type = informational_bar_mini
title_color オプション 弦 Available when: type = informational_bar_mini
description_color オプション 弦 Available when: type = informational_bar_mini
background_color オプション 弦 Available when: type = informational_bar_mini
image
title オプション 弦 Available when: type = image
image オプション ファイル Available when: type = image
image_alt オプション 弦 Available when: type = image
button_url オプション 弦 Available when: type = image
button_text オプション 弦 Available when: type = image
title_color オプション 弦 Available when: type = image
background_color オプション 弦 Available when: type = image
button_background_color オプション 弦 Available when: type = image
button_color オプション 弦 Available when: type = image
collector_bar
title オプション 弦 Available when: type = collector_bar
input_placeholder オプション 弦 Available when: type = collector_bar
button_text オプション 弦 Available when: type = collector_bar
show_agreement オプション ブール値 Available when: type = collector_bar
agreement_text オプション 弦 Available when: type = collector_bar
agreement_url オプション 弦 Available when: type = collector_bar
thank_you_url オプション 弦 Available when: type = collector_bar
title_color オプション 弦 Available when: type = collector_bar
background_color オプション 弦 Available when: type = collector_bar
button_background_color オプション 弦 Available when: type = collector_bar
button_color オプション 弦 Available when: type = collector_bar
coupon_bar
title オプション 弦 Available when: type = coupon_bar
coupon_code オプション 弦 Available when: type = coupon_bar
url オプション 浮く Available when: type = coupon_bar
url_new_tab オプション ブール値 Available when: type = coupon_bar
title_color オプション 弦 Available when: type = coupon_bar
background_color オプション 弦 Available when: type = coupon_bar
coupon_code_color オプション 弦 Available when: type = coupon_bar
coupon_code_background_color オプション 弦 Available when: type = coupon_bar
coupon_code_border_color オプション 弦 Available when: type = coupon_bar
button_bar
title オプション 弦 Available when: type = button_bar
button_text オプション 弦 Available when: type = button_bar
url オプション 弦 Available when: type = button_bar
url_new_tab オプション ブール値 Available when: type = button_bar
title_color オプション 弦 Available when: type = button_bar
background_color オプション 弦 Available when: type = button_bar
button_color オプション 弦 Available when: type = button_bar
button_background_color オプション 弦 Available when: type = button_bar
collector_modal
title オプション 弦 Available when: type = collector_modal
description オプション 弦 Available when: type = collector_modal
image オプション ファイル Available when: type = collector_modal
image_alt オプション 弦 Available when: type = collector_modal
input_placeholder オプション 弦 Available when: type = collector_modal
button_text オプション 弦 Available when: type = collector_modal
show_agreement オプション ブール値 Available when: type = collector_modal
agreement_text オプション 弦 Available when: type = collector_modal
agreement_url オプション 弦 Available when: type = collector_modal
thank_you_url オプション 弦 Available when: type = collector_modal
title_color オプション 弦 Available when: type = collector_modal
description_color オプション 弦 Available when: type = collector_modal
background_color オプション 弦 Available when: type = collector_modal
button_background_color オプション 弦 Available when: type = collector_modal
button_color オプション 弦 Available when: type = collector_modal
collector_two_modal
title オプション 弦 Available when: type = collector_two_modal
description オプション 弦 Available when: type = collector_two_modal
image オプション ファイル Available when: type = collector_two_modal
image_alt オプション 弦 Available when: type = collector_two_modal
input_placeholder オプション 弦 Available when: type = collector_two_modal
button_text オプション 弦 Available when: type = collector_two_modal
show_agreement オプション ブール値 Available when: type = collector_two_modal
agreement_text オプション 弦 Available when: type = collector_two_modal
agreement_url オプション 弦 Available when: type = collector_two_modal
thank_you_url オプション 弦 Available when: type = collector_two_modal
title_color オプション 弦 Available when: type = collector_two_modal
description_color オプション 弦 Available when: type = collector_two_modal
background_color オプション 弦 Available when: type = collector_two_modal
button_background_color オプション 弦 Available when: type = collector_two_modal
button_color オプション 弦 Available when: type = collector_two_modal
button_modal
title オプション 弦 Available when: type = button_modal
description オプション 弦 Available when: type = button_modal
image オプション ファイル Available when: type = button_modal
image_alt オプション 弦 Available when: type = button_modal
button_text オプション 弦 Available when: type = button_modal
button_url オプション 弦 Available when: type = button_modal
url_new_tab オプション ブール値 Available when: type = button_modal
title_color オプション 弦 Available when: type = button_modal
description_color オプション 弦 Available when: type = button_modal
background_color オプション 弦 Available when: type = button_modal
button_background_color オプション 弦 Available when: type = button_modal
button_color オプション 弦 Available when: type = button_modal
text_feedback
title オプション 弦 Available when: type = text_feedback
description オプション 弦 Available when: type = text_feedback
input_placeholder オプション 弦 Available when: type = text_feedback
button_text オプション 弦 Available when: type = text_feedback
thank_you_url オプション 弦 Available when: type = text_feedback
title_color オプション 弦 Available when: type = text_feedback
description_color オプション 弦 Available when: type = text_feedback
background_color オプション 弦 Available when: type = text_feedback
button_background_color オプション 弦 Available when: type = text_feedback
button_color オプション 弦 Available when: type = text_feedback
engagement_links
title_color オプション 弦 Available when: type = text_feedback
categories_title_color オプション 弦 Available when: type = text_feedback
categories_description_color オプション 弦 Available when: type = text_feedback
categories_links_title_color オプション 弦 Available when: type = text_feedback
categories_links_description_color オプション 弦 Available when: type = text_feedback
categories_links_background_color オプション 弦 Available when: type = text_feedback
categories_links_border_color オプション 弦 Available when: type = text_feedback
background_color オプション 弦 Available when: type = text_feedback
whatsapp_chat
title オプション 弦 Available when: type = whatsapp_chat
agent_image オプション ファイル Available when: type = whatsapp_chat
agent_image_alt オプション 弦 Available when: type = whatsapp_chat
agent_name オプション 弦 Available when: type = whatsapp_chat
agent_description オプション 弦 Available when: type = whatsapp_chat
agent_message オプション 弦 Available when: type = whatsapp_chat
agent_phone_number オプション 弦 Available when: type = whatsapp_chat
button_text オプション 弦 Available when: type = whatsapp_chat
header_agent_name_color オプション 弦 Available when: type = whatsapp_chat
header_agent_description_color オプション 弦 Available when: type = whatsapp_chat
header_background_color オプション 弦 Available when: type = whatsapp_chat
content_background_color オプション 弦 Available when: type = whatsapp_chat
content_agent_name_color オプション 弦 Available when: type = whatsapp_chat
content_agent_message_color オプション 弦 Available when: type = whatsapp_chat
content_agent_message_background_color オプション 弦 Available when: type = whatsapp_chat
footer_background_color オプション 弦 Available when: type = whatsapp_chat
footer_button_background_color オプション 弦 Available when: type = whatsapp_chat
footer_button_color オプション 弦 Available when: type = whatsapp_chat
title_color オプション 弦 Available when: type = whatsapp_chat
background_color オプション 弦 Available when: type = whatsapp_chat
contact_us
title オプション 弦 Available when: type = contact_us
description オプション 弦 Available when: type = contact_us
contact_email オプション 弦 Available when: type = contact_us
contact_phone_number オプション 弦 Available when: type = contact_us
contact_whatsapp オプション 弦 Available when: type = contact_us
contact_telegram オプション 弦 Available when: type = contact_us
contact_facebook_messenger オプション 弦 Available when: type = contact_us
title_color オプション 弦 Available when: type = contact_us
description_color オプション 弦 Available when: type = contact_us
background_color オプション 弦 Available when: type = contact_us
curl --request POST \
--url 'https://popupke.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 https://popupke.com/api/notifications/{notification_id}
curl --request DELETE \
--url 'https://popupke.com/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \