キャンペーン通知

すべて取得する

GET https://notifyc.com/api/notifications/
curl --request GET \
--url 'https://notifyc.com/api/notifications/' \
--header 'Authorization: Bearer {api_key}' \
パラメータ 詳細 説明
search オプション 文字列 検索文字列。
search_by オプション 文字列 検索するフィールドは何ですか。許可されている値は：name。
is_enabled オプション ブール値
type オプション 文字列 許可された値: 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, badge
datetime_field オプション 文字列 許可された値: datetime, last_datetime
datetime_start オプション 文字列 Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end オプション 文字列 Filter results up to this datetime. Y-m-d H:i:s format.
order_by オプション 文字列 結果をどのフィールドで並べ替えるか。許可されている値は：notification_id, datetime, last_datetime, name, impressions, hovers, clicks, form_submissions。
order_type オプション 文字列 結果の並び順。許可されている値は、昇順のためのASCと、降順のためのDESCです。
page オプション 整数 結果を取得したいページ番号。デフォルトは1です。
results_per_page オプション 整数 1ページあたりの結果数はどのくらいにしますか。許可されている値は：10, 25, 50, 100, 250, 500, 1000。デフォルトは25です。 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "campaign_id": 1,
            "notification_key": "Example",
            "name": "Example",
            "type": "Example",
            "settings": [],
            "impressions": 1,
            "hovers": 1,
            "clicks": 1,
            "form_submissions": 1,
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-10-21 00:30:56"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://notifyc.com/api/notifications?page=1",
        "last": "https://notifyc.com/api/notifications?page=1",
        "next": null,
        "prev": null,
        "self": "https://notifyc.com/api/notifications?page=1"
    }
}

1つ取得する

GET https://notifyc.com/api/notifications/{notification_id}
curl --request GET \
--url 'https://notifyc.com/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "campaign_id": 1,
        "notification_key": "Example",
        "name": "Example",
        "type": "Example",
        "settings": [],
        "impressions": 1,
        "hovers": 1,
        "clicks": 1,
        "form_submissions": 1,
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-21 00:30:56"
    }
}

作成する

POST https://notifyc.com/api/notifications
パラメータ 詳細 説明
campaign_id 必須 整数 -
type 必須 文字列 許可された値: 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, badge
name オプション 文字列 -
is_enabled オプション ブール値 -
curl --request POST \
--url 'https://notifyc.com/api/notifications' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'type=informational' \
--form 'is_enabled=1' 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "campaign_id": 1,
        "notification_key": "Example",
        "name": "Example",
        "type": "Example",
        "settings": {},
        "impressions": "Example",
        "hovers": "Example",
        "clicks": 1,
        "form_submissions": "Example",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-21 00:30:56"
    }
}

更新

POST https://notifyc.com/api/notifications/{notification_id}
パラメータ 詳細 説明
name オプション 文字列 -
is_enabled オプション ブール値 -
trigger_all_pages オプション ブール値 -
display_trigger オプション 文字列 許可された値: delay, time_on_site, pageviews, inactivity, exit_intent, scroll, target_visible, click, hover
display_trigger_value オプション 文字列 -
display_trigger_selector オプション 文字列 利用可能な時期: display_trigger = target_visible
display_delay_type_after_close オプション 文字列 許可された値: time_on_site, pageviews
display_delay_value_after_close オプション 整数 -
display_focus オプション ブール値 -
display_focus_behavior オプション 文字列 許可された値: visual_only, outside_click_unfocus, lock_until_interaction
display_frequency オプション 文字列 許可された値: all_time, once_per_session, once_per_browser
direction オプション 文字列 許可された値: 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 オプション 文字列 許可された値: 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 オプション ブール値 -
close_button_color オプション 文字列 -
dark_mode_close_button_color オプション 文字列 -
display_branding オプション ブール値 -
shadow オプション 文字列 許可された値: , subtle, feather, 3d, layered
border_width オプション 整数 許可された値: 0, 1, 2, 3, 4, 5
internal_padding オプション 整数 許可された値: 5-25
background_blur オプション 整数 許可された値: 0-30
custom_css オプション 文字列 -
hover_animation オプション 文字列 許可された値: , fast_scale_up, slow_scale_up, fast_scale_down, slow_scale_down
on_animation オプション 文字列 許可された値: fadeIn, slideInUp, slideInDown, zoomIn, bounceIn
off_animation オプション 文字列 許可された値: fadeOut, slideOutUp, slideOutDown, zoomOut, bounceOut
animation オプション 文字列 許可された値: , heartbeat, bounce, flash, pulse
animation_interval オプション 整数 -
font オプション 文字列 許可された値: 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 オプション 文字列 許可された値: straight, rounded, highly_rounded, round
dark_mode_is_enabled オプション ブール値
notifications オプション 配列 利用可能な時期: type = email_collector, collector_bar, collector_modal, collector_two_modal, conversions, inline_conversions, conversions_counter, inline_conversions_counter, countdown_collector, request_collector, text_feedback 通知ハンドラーID
translations[input_key][index]['key'] オプション 文字列 Available for all the marked for translation fields.
translations[input_key][index]['value'] オプション 文字列 Available for all the marked for translation fields.
conversions / inline_conversions
title オプション 文字列 利用可能な時期: type = conversions, inline_conversions
description オプション 文字列 利用可能な時期: type = conversions, inline_conversions
image オプション ファイル 利用可能な時期: type = conversions, inline_conversions
image_alt オプション 文字列 利用可能な時期: type = conversions, inline_conversions
url オプション 文字列 利用可能な時期: type = conversions, inline_conversions
display_time オプション ブール値 利用可能な時期: type = conversions, inline_conversions
url_new_tab オプション ブール値 利用可能な時期: type = conversions, inline_conversions
conversions_count オプション 整数 利用可能な時期: type = conversions, inline_conversions
in_between_delay オプション 整数 利用可能な時期: type = conversions, inline_conversions
order オプション 文字列 利用可能な時期: type = conversions, inline_conversions
許可された値: random, descending
data_trigger_auto オプション ブール値 利用可能な時期: type = conversions, inline_conversions
data_trigger_auto_type[index] オプション 配列 文字列 利用可能な時期: type = conversions, inline_conversions
許可された値: exact, contains, starts_with, ends_with
data_trigger_auto_value[index] オプション 配列 文字列 利用可能な時期: type = conversions, inline_conversions
title_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
description_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
date_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
background_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
border_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
shadow_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
dark_mode_title_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
dark_mode_description_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
dark_mode_date_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
dark_mode_background_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
dark_mode_border_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
dark_mode_shadow_color オプション 文字列 利用可能な時期: type = conversions, inline_conversions
data_trigger_auto オプション ブール値 利用可能な時期: type = conversions counter
data_trigger_auto_type[index] オプション 配列 文字列 利用可能な時期: type = conversions, inline_conversions
許可された値: exact, contains, starts_with, ends_with
data_trigger_auto_value[index] オプション 配列 文字列 利用可能な時期: type = conversions, inline_conversions
rating_summary / inline_rating_summary
description オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary Translatable
average_rating オプション 浮動小数点 利用可能な時期: type = rating_summary, inline_rating_summary
reviews_count オプション api_documentation.integer 利用可能な時期: type = rating_summary, inline_rating_summary
display_minimum_reviews オプション api_documentation.integer 利用可能な時期: type = rating_summary, inline_rating_summary
url オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
url_new_tab オプション ブール値 利用可能な時期: type = rating_summary, inline_rating_summary
selector オプション 文字列 利用可能な時期: type = inline_rating_summary
inline_placement オプション 文字列 利用可能な時期: type = inline_rating_summary
rating_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
rating_background_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
stars_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
description_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
background_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
border_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
shadow_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
dark_mode_rating_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
dark_mode_rating_background_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
dark_mode_stars_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
dark_mode_description_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
dark_mode_background_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
dark_mode_border_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
dark_mode_shadow_color オプション 文字列 利用可能な時期: type = rating_summary, inline_rating_summary
telegram_chat
title オプション 文字列 利用可能な時期: type = telegram_chat
agent_image オプション ファイル 利用可能な時期: type = telegram_chat
agent_image_alt オプション 文字列 利用可能な時期: type = telegram_chat
agent_name オプション 文字列 利用可能な時期: type = telegram_chat Translatable
agent_description オプション 文字列 利用可能な時期: type = telegram_chat Translatable
agent_message オプション 文字列 利用可能な時期: type = telegram_chat Translatable
agent_telegram オプション 文字列 利用可能な時期: type = telegram_chat Translatable
button_text オプション 文字列 利用可能な時期: type = telegram_chat Translatable
header_agent_name_color オプション 文字列 利用可能な時期: type = telegram_chat
header_agent_description_color オプション 文字列 利用可能な時期: type = telegram_chat
header_background_color オプション 文字列 利用可能な時期: type = telegram_chat
content_background_color オプション 文字列 利用可能な時期: type = telegram_chat
content_agent_name_color オプション 文字列 利用可能な時期: type = telegram_chat
content_agent_message_color オプション 文字列 利用可能な時期: type = telegram_chat
content_agent_message_background_color オプション 文字列 利用可能な時期: type = telegram_chat
footer_background_color オプション 文字列 利用可能な時期: type = telegram_chat
footer_button_background_color オプション 文字列 利用可能な時期: type = telegram_chat
footer_button_color オプション 文字列 利用可能な時期: type = telegram_chat
title_color オプション 文字列 利用可能な時期: type = telegram_chat
background_color オプション 文字列 利用可能な時期: type = telegram_chat
border_color オプション 文字列 利用可能な時期: type = telegram_chat
shadow_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_header_agent_name_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_header_agent_description_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_header_background_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_content_background_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_content_agent_name_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_content_agent_message_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_content_agent_message_background_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_footer_background_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_footer_button_background_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_footer_button_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_title_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_background_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_border_color オプション 文字列 利用可能な時期: type = telegram_chat
dark_mode_shadow_color オプション 文字列 利用可能な時期: type = telegram_chat
facebook_messenger_chat
display_continents オプション 文字列 -
display_countries オプション 文字列 -
display_languages オプション 文字列 -
display_operating_systems オプション 文字列 -
display_browsers オプション 文字列 -
display_cities オプション 文字列 -
infinite_rotation オプション 文字列 -
video_is_vimeo オプション 文字列 -
vimeo_video_id オプション 整数 -
badge_text オプション 文字列 -
hint_text オプション 文字列 -
items オプション 配列 -
trigger_type オプション 文字列 -
trigger_value オプション 整数 -
border_color オプション 文字列 -
dark_mode_border_color オプション 文字列 -
shadow_color オプション 文字列 -
dark_mode_shadow_color オプション 文字列 -
title_color オプション 文字列 -
description_color オプション 文字列 -
background_color オプション 文字列 -
dark_mode_title_color オプション 文字列 -
dark_mode_description_color オプション 文字列 -
dark_mode_background_color オプション 文字列 -
margin_top オプション 文字列 -
margin_right オプション 文字列 -
margin_bottom オプション 文字列 -
margin_left オプション 文字列 -
button_background_color オプション 文字列 -
button_color オプション 文字列 -
dark_mode_button_background_color オプション 文字列 -
dark_mode_button_color オプション 文字列 -
number_background_color オプション 文字列 -
number_color オプション 文字列 -
pulse_background_color オプション 文字列 -
dark_mode_number_background_color オプション 文字列 -
dark_mode_number_color オプション 文字列 -
dark_mode_pulse_background_color オプション 文字列 -
date_color オプション 文字列 -
dark_mode_date_color オプション 文字列 -
rating_color オプション 文字列 -
rating_background_color オプション 文字列 -
stars_color オプション 文字列 -
dark_mode_rating_color オプション 文字列 -
dark_mode_rating_background_color オプション 文字列 -
dark_mode_stars_color オプション 文字列 -
content_title_color オプション 文字列 -
content_description_color オプション 文字列 -
dark_mode_content_title_color オプション 文字列 -
dark_mode_content_description_color オプション 文字列 -
time_color オプション 文字列 -
time_background_color オプション 文字列 -
dark_mode_time_color オプション 文字列 -
dark_mode_time_background_color オプション 文字列 -
coupon_code_color オプション 文字列 -
coupon_code_background_color オプション 文字列 -
coupon_code_border_color オプション 文字列 -
dark_mode_coupon_code_color オプション 文字列 -
dark_mode_coupon_code_background_color オプション 文字列 -
dark_mode_coupon_code_border_color オプション 文字列 -
categories_title_color オプション 文字列 -
categories_description_color オプション 文字列 -
categories_links_title_color オプション 文字列 -
categories_links_description_color オプション 文字列 -
categories_links_background_color オプション 文字列 -
categories_links_border_color オプション 文字列 -
dark_mode_categories_title_color オプション 文字列 -
dark_mode_categories_description_color オプション 文字列 -
dark_mode_categories_links_title_color オプション 文字列 -
dark_mode_categories_links_description_color オプション 文字列 -
dark_mode_categories_links_background_color オプション 文字列 -
dark_mode_categories_links_border_color オプション 文字列 -
badge_background_color オプション 文字列 -
badge_color オプション 文字列 -
hint_background_color オプション 文字列 -
hint_color オプション 文字列 -
item_question_color オプション 文字列 -
item_answer_color オプション 文字列 -
item_background_color オプション 文字列 -
item_border_color オプション 文字列 -
dark_mode_badge_background_color オプション 文字列 -
dark_mode_badge_color オプション 文字列 -
dark_mode_hint_background_color オプション 文字列 -
dark_mode_hint_color オプション 文字列 -
dark_mode_item_question_color オプション 文字列 -
dark_mode_item_answer_color オプション 文字列 -
dark_mode_item_background_color オプション 文字列 -
dark_mode_item_border_color オプション 文字列 -
header_agent_name_color オプション 文字列 -
header_agent_description_color オプション 文字列 -
header_background_color オプション 文字列 -
content_background_color オプション 文字列 -
content_agent_name_color オプション 文字列 -
content_agent_message_color オプション 文字列 -
content_agent_message_background_color オプション 文字列 -
footer_background_color オプション 文字列 -
footer_button_background_color オプション 文字列 -
footer_button_color オプション 文字列 -
dark_mode_header_agent_name_color オプション 文字列 -
dark_mode_header_agent_description_color オプション 文字列 -
dark_mode_header_background_color オプション 文字列 -
dark_mode_content_background_color オプション 文字列 -
dark_mode_content_agent_name_color オプション 文字列 -
dark_mode_content_agent_message_color オプション 文字列 -
dark_mode_content_agent_message_background_color オプション 文字列 -
dark_mode_footer_background_color オプション 文字列 -
dark_mode_footer_button_background_color オプション 文字列 -
dark_mode_footer_button_color オプション 文字列 -
curl --request POST \
--url 'https://notifyc.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,
        "user_id": 1,
        "campaign_id": 1,
        "notification_key": "Example",
        "name": "Example",
        "type": "Example",
        "settings": {},
        "impressions": 1,
        "hovers": 1,
        "clicks": 1,
        "form_submissions": 1,
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-21 00:30:56"
    }
}

削除

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