Notificações de campanha

Recuperar todos

Ponto de extremidade

GET https://vortex.alyra.com.br/api/notifications/

Exemplo

curl --request GET \
--url 'https://vortex.alyra.com.br/api/notifications/' \
--header 'Authorization: Bearer {api_key}' \

Parâmetros	Detalhes	Descrição
page	Opcional Inteiro	O número da página da qual você deseja os resultados. O padrão é `1`.
results_per_page	Opcional Inteiro	Quantos resultados você quer por página. Os valores permitidos são: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. O padrão é `25`.

Exemplo de resposta

{ "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-04 20:50:18" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://vortex.alyra.com.br/api/notifications?&page=1", "last": "https://vortex.alyra.com.br/api/notifications?&page=1", "next": null, "prev": null, "self": "https://vortex.alyra.com.br/api/notifications?&page=1" } }

Recuperar um

Ponto de extremidade

GET https://vortex.alyra.com.br/api/notifications/{notification_id}

Exemplo

curl --request GET \
--url 'https://vortex.alyra.com.br/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \

Exemplo de resposta

{ "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-04 20:50:18" } }

Criar

Ponto de extremidade

POST https://vortex.alyra.com.br/api/notifications

Parâmetros	Detalhes	Descrição
campaign_id	Obrigatório Inteiro	-
type	Obrigatório Corda	Valores permitidos: `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`
name	Opcional Corda	-
is_enabled	Opcional Booleano	-

Exemplo

curl --request POST \
--url 'https://vortex.alyra.com.br/api/notifications' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'type=INFORMATIONAL' \
--form 'is_enabled=1'

Exemplo de resposta

{ "data": { "id": 1 } }

Atualizar

Ponto de extremidade

POST https://vortex.alyra.com.br/api/notifications/{notification_id}

Parâmetros	Detalhes	Descrição
name	Opcional Corda	-
is_enabled	Opcional Booleano	-
trigger_all_pages	Opcional Booleano	-
display_trigger	Opcional Corda	Valores permitidos: `delay`, `time_on_site`, `pageviews`, `inactivity`, `exit_intent`, `scroll`, `click`, `hover`
display_value	Opcional Corda	-
display_delay_type_after_close	Opcional Corda	Valores permitidos: `time_on_site`, `pageviews`
display_delay_value_after_close	Opcional Inteiro	-
display_frequency	Opcional Corda	Valores permitidos: `all_time`, `once_per_session`, `once_per_browser`
direction	Opcional Corda	Valores permitidos: `rtl`, `ltr`
display_continents	Opcional Matriz Corda	-
display_countries	Opcional Matriz Corda	-
display_languages	Opcional Matriz Corda	-
display_operating_systems	Opcional Matriz Corda	-
display_browsers	Opcional Matriz Corda	-
display_cities	Opcional Matriz Corda	-
display_mobile	Opcional Booleano	-
display_desktop	Opcional Booleano	-
schedule	Opcional Booleano	-
start_date	Opcional Corda	-
end_date	Opcional Corda	-
display_duration	Opcional Inteiro	-
display_position	Opcional Corda	Valores permitidos: `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	Opcional Booleano	-
display_branding	Opcional Booleano	-
shadow	Opcional Corda	Valores permitidos: , `subtle`, `feather`, `3d`, `layered`
border_width	Opcional Inteiro	Valores permitidos: `0`, `1`, `2`, `3`, `4`, `5`
internal_padding	Opcional Inteiro	Valores permitidos: `5-25`
background_blur	Opcional Inteiro	Valores permitidos: `0-30`
custom_css	Opcional Corda	-
hover_animation	Opcional Corda	Valores permitidos: , `fast_scale_up`, `slow_scale_up`, `fast_scale_down`, `slow_scale_down`
on_animation	Opcional Corda	Valores permitidos: `fadeIn`, `slideInUp`, `slideInDown`, `zoomIn`, `bounceIn`
off_animation	Opcional Corda	Valores permitidos: `fadeOut`, `slideOutUp`, `slideOutDown`, `zoomOut`, `bounceOut`
animation	Opcional Corda	Valores permitidos: , `heartbeat`, `bounce`, `flash`, `pulse`
animation_interval	Opcional Inteiro	-
font	Opcional Corda	Valores permitidos: `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	Opcional Corda	Valores permitidos: `straight`, `rounded`, `highly_rounded`, `round`
notifications	Opcional Matriz	Disponível quando: type = email_collector, collector_bar, collector_modal, collector_two_modal, conversions, conversions_counter, countdown_collector, request_collector, text_feedback IDs do manipulador de notificações
informational
title	Opcional Corda	Disponível quando: type = informational
description	Opcional Corda	Disponível quando: type = informational
image	Opcional Arquivo	Disponível quando: type = informational
image_alt	Opcional Corda	Disponível quando: type = informational
url	Opcional Corda	Disponível quando: type = informational
url_new_tab	Opcional Booleano	Disponível quando: type = informational
title_color	Opcional Corda	Disponível quando: type = informational
description_color	Opcional Corda	Disponível quando: type = informational
background_color	Opcional Corda	Disponível quando: type = informational
informational_mini
title	Opcional Corda	Disponível quando: type = informational_mini
image	Opcional Arquivo	Disponível quando: type = informational_mini
image_alt	Opcional Corda	Disponível quando: type = informational_mini
url	Opcional Corda	Disponível quando: type = informational_mini
url_new_tab	Opcional Booleano	Disponível quando: type = informational_mini
title_color	Opcional Corda	Disponível quando: type = informational_mini
description_color	Opcional Corda	Disponível quando: type = informational_mini
background_color	Opcional Corda	Disponível quando: type = informational_mini
coupon
title	Opcional Corda	Disponível quando: type = coupon
description	Opcional Corda	Disponível quando: type = coupon
image	Opcional Arquivo	Disponível quando: type = coupon
image_alt	Opcional Corda	Disponível quando: type = coupon
coupon_code	Opcional Corda	Disponível quando: type = coupon
button_url	Opcional Corda	Disponível quando: type = coupon
url_new_tab	Opcional Booleano	Disponível quando: type = coupon
button_text	Opcional Corda	Disponível quando: type = coupon
title_color	Opcional Corda	Disponível quando: type = coupon
description_color	Opcional Corda	Disponível quando: type = coupon
background_color	Opcional Corda	Disponível quando: type = coupon
button_background_color	Opcional Corda	Disponível quando: type = coupon
button_color	Opcional Corda	Disponível quando: type = coupon
live_counter
description	Opcional Corda	Disponível quando: type = live_counter
last_activity	Opcional Corda	Disponível quando: type = live_counter
url	Opcional Corda	Disponível quando: type = live_counter
url_new_tab	Opcional Booleano	Disponível quando: type = live_counter
display_minimum_activity	Opcional Inteiro	Disponível quando: type = live_counter
description_color	Opcional Corda	Disponível quando: type = live_counter
background_color	Opcional Corda	Disponível quando: type = live_counter
number_background_color	Opcional Corda	Disponível quando: type = live_counter
number_color	Opcional Corda	Disponível quando: type = live_counter
pulse_background_color	Opcional Corda	Disponível quando: type = live_counter
email_collector
title	Opcional Corda	Disponível quando: type = email_collector
description	Opcional Corda	Disponível quando: type = email_collector
name_placeholder	Opcional Corda	Disponível quando: type = email_collector
email_placeholder	Opcional Corda	Disponível quando: type = email_collector
button_text	Opcional Corda	Disponível quando: type = email_collector
show_agreement	Opcional Booleano	Disponível quando: type = email_collector
agreement_text	Opcional Corda	Disponível quando: type = email_collector
agreement_url	Opcional Corda	Disponível quando: type = email_collector
thank_you_url	Opcional Corda	Disponível quando: type = email_collector
title_color	Opcional Corda	Disponível quando: type = email_collector
description_color	Opcional Corda	Disponível quando: type = email_collector
background_color	Opcional Corda	Disponível quando: type = email_collector
button_background_color	Opcional Corda	Disponível quando: type = email_collector
button_color	Opcional Corda	Disponível quando: type = email_collector
conversions
title	Opcional Corda	Disponível quando: type = conversions
description	Opcional Corda	Disponível quando: type = conversions
image	Opcional Arquivo	Disponível quando: type = conversions
image_alt	Opcional Corda	Disponível quando: type = conversions
url	Opcional Corda	Disponível quando: type = conversions
url_new_tab	Opcional Booleano	Disponível quando: type = conversions
conversions_count	Opcional Inteiro	Disponível quando: type = conversions
in_between_delay	Opcional Inteiro	Disponível quando: type = conversions
order	Opcional Corda	Disponível quando: type = conversions Valores permitidos: `random`, `descending`
data_trigger_auto	Opcional Booleano	Disponível quando: type = conversions
data_trigger_auto_type[index]	Opcional Matriz Corda	Disponível quando: type = conversions Valores permitidos: `exact` , `contains` , `starts_with` , `ends_with`
data_trigger_auto_value[index]	Opcional Matriz Corda	Disponível quando: type = conversions
title_color	Opcional Corda	Disponível quando: type = conversions
description_color	Opcional Corda	Disponível quando: type = conversions
date_color	Opcional Corda	Disponível quando: type = conversions
background_color	Opcional Corda	Disponível quando: type = conversions
conversions counter
title	Opcional Corda	Disponível quando: type = conversions counter
last_activity	Opcional Corda	Disponível quando: type = conversions counter
url	Opcional Corda	Disponível quando: type = conversions counter
url_new_tab	Opcional Booleano	Disponível quando: type = conversions counter
display_minimum_activity	Opcional Corda	Disponível quando: type = conversions counter
title_color	Opcional Corda	Disponível quando: type = conversions counter
background_color	Opcional Corda	Disponível quando: type = conversions counter
number_background_color	Opcional Corda	Disponível quando: type = conversions counter
number_color	Opcional Corda	Disponível quando: type = conversions counter
data_trigger_auto	Opcional Booleano	Disponível quando: type = conversions counter
data_trigger_auto_type[index]	Opcional Matriz Corda	Disponível quando: type = conversions Valores permitidos: `exact` , `contains` , `starts_with` , `ends_with`
data_trigger_auto_value[index]	Opcional Matriz Corda	Disponível quando: type = conversions
video
title	Opcional Corda	Disponível quando: type = video
video	Opcional Arquivo	Disponível quando: type = video
video_is_youtube	Opcional Booleano	Disponível quando: type = video
youtube_video_id	Opcional Corda	Disponível quando: type = video
video_autoplay	Opcional Booleano	Disponível quando: type = video
video_controls	Opcional Booleano	Disponível quando: type = video
video_loop	Opcional Booleano	Disponível quando: type = video
video_muted	Opcional Booleano	Disponível quando: type = video
button_url	Opcional Corda	Disponível quando: type = video
button_text	Opcional Corda	Disponível quando: type = video
url_new_tab	Opcional Booleano	Disponível quando: type = video
title_color	Opcional Corda	Disponível quando: type = video
background_color	Opcional Corda	Disponível quando: type = video
button_background_color	Opcional Corda	Disponível quando: type = video
button_color	Opcional Corda	Disponível quando: type = video
audio
title	Opcional Corda	Disponível quando: type = audio
audio	Opcional Arquivo	Disponível quando: type = audio
audio_autoplay	Opcional Booleano	Disponível quando: type = audio
audio_controls	Opcional Booleano	Disponível quando: type = audio
audio_loop	Opcional Booleano	Disponível quando: type = audio
audio_muted	Opcional Booleano	Disponível quando: type = audio
button_url	Opcional Corda	Disponível quando: type = audio
button_text	Opcional Corda	Disponível quando: type = audio
url_new_tab	Opcional Booleano	Disponível quando: type = audio
title_color	Opcional Corda	Disponível quando: type = audio
background_color	Opcional Corda	Disponível quando: type = audio
button_background_color	Opcional Corda	Disponível quando: type = audio
button_color	Opcional Corda	Disponível quando: type = audio
social_share
title	Opcional Corda	Disponível quando: type = social_share
description	Opcional Corda	Disponível quando: type = social_share
share_url	Opcional Corda	Disponível quando: type = social_share
share_facebook	Opcional Booleano	Disponível quando: type = social_share
share_x	Opcional Booleano	Disponível quando: type = social_share
share_threads	Opcional Booleano	Disponível quando: type = social_share
share_linkedin	Opcional Booleano	Disponível quando: type = social_share
share_reddit	Opcional Booleano	Disponível quando: type = social_share
share_pinterest	Opcional Booleano	Disponível quando: type = social_share
share_tumblr	Opcional Booleano	Disponível quando: type = social_share
share_telegram	Opcional Booleano	Disponível quando: type = social_share
share_whatsapp	Opcional Booleano	Disponível quando: type = social_share
title_color	Opcional Corda	Disponível quando: type = social_share
description_color	Opcional Corda	Disponível quando: type = social_share
background_color	Opcional Corda	Disponível quando: type = social_share
reviews
url	Opcional Corda	Disponível quando: type = reviews
url_new_tab	Opcional Booleano	Disponível quando: type = reviews
reviews_count	Opcional missing_translation: api_documentation.integer	Disponível quando: type = reviews
in_between_delay	Opcional missing_translation: api_documentation.integer	Disponível quando: type = reviews
order	Opcional Corda	Disponível quando: type = reviews
title	missing_translation: api_documentation.default Corda	Disponível quando: type = reviews
description	missing_translation: api_documentation.default Corda	Disponível quando: type = reviews
image	missing_translation: api_documentation.default Arquivo	Disponível quando: type = reviews
stars	missing_translation: api_documentation.default missing_translation: api_documentation.integer	Disponível quando: type = reviews
title_color	Opcional Corda	Disponível quando: type = reviews
description_color	Opcional Corda	Disponível quando: type = reviews
background_color	Opcional Corda	Disponível quando: type = reviews
emoji_feedback
title	Opcional Corda	Disponível quando: type = emoji_feedback
thank_you_url	Opcional Corda	Disponível quando: type = emoji_feedback
show_angry	Opcional Booleano	Disponível quando: type = emoji_feedback
show_sad	Opcional Booleano	Disponível quando: type = emoji_feedback
show_neutral	Opcional Booleano	Disponível quando: type = emoji_feedback
show_happy	Opcional Booleano	Disponível quando: type = emoji_feedback
show_excited	Opcional Booleano	Disponível quando: type = emoji_feedback
title_color	Opcional Corda	Disponível quando: type = emoji_feedback
background_color	Opcional Corda	Disponível quando: type = emoji_feedback
cookie_notification
description	Opcional Corda	Disponível quando: type = cookie_notification
image	Opcional Arquivo	Disponível quando: type = cookie_notification
image_alt	Opcional Flutuar	Disponível quando: type = cookie_notification
url_text	Opcional Corda	Disponível quando: type = cookie_notification
url	Opcional Corda	Disponível quando: type = cookie_notification
button_text	Opcional Corda	Disponível quando: type = cookie_notification
description_color	Opcional Corda	Disponível quando: type = cookie_notification
background_color	Opcional Corda	Disponível quando: type = cookie_notification
button_background_color	Opcional Corda	Disponível quando: type = cookie_notification
button_color	Opcional Corda	Disponível quando: type = cookie_notification
score_feedback
title	Opcional Corda	Disponível quando: type = score_feedback
description	Opcional Corda	Disponível quando: type = score_feedback
thank_you_url	Opcional Corda	Disponível quando: type = score_feedback
title_color	Opcional Corda	Disponível quando: type = score_feedback
description_color	Opcional Corda	Disponível quando: type = score_feedback
background_color	Opcional Corda	Disponível quando: type = score_feedback
button_background_color	Opcional Corda	Disponível quando: type = score_feedback
button_color	Opcional Corda	Disponível quando: type = score_feedback
request_collector
title	Opcional Corda	Disponível quando: type = request_collector
description	Opcional Corda	Disponível quando: type = request_collector
image	Opcional Arquivo	Disponível quando: type = request_collector
image_alt	Opcional Corda	Disponível quando: type = request_collector
content_title	Opcional Corda	Disponível quando: type = request_collector
content_description	Opcional Corda	Disponível quando: type = request_collector
input_placeholder	Opcional Corda	Disponível quando: type = request_collector
button_text	Opcional Corda	Disponível quando: type = request_collector
show_agreement	Opcional Booleano	Disponível quando: type = request_collector
agreement_text	Opcional Corda	Disponível quando: type = request_collector
agreement_url	Opcional Corda	Disponível quando: type = request_collector
thank_you_url	Opcional Corda	Disponível quando: type = request_collector
title_color	Opcional Corda	Disponível quando: type = request_collector
description_color	Opcional Corda	Disponível quando: type = request_collector
content_title_color	Opcional Corda	Disponível quando: type = request_collector
content_description_color	Opcional Corda	Disponível quando: type = request_collector
background_color	Opcional Corda	Disponível quando: type = request_collector
button_background_color	Opcional Corda	Disponível quando: type = request_collector
button_color	Opcional Corda	Disponível quando: type = request_collector
countdown_collector
title	Opcional Corda	Disponível quando: type = countdown_collector
description	Opcional Corda	Disponível quando: type = countdown_collector
content_title	Opcional Corda	Disponível quando: type = countdown_collector
input_placeholder	Opcional Corda	Disponível quando: type = countdown_collector
button_text	Opcional Corda	Disponível quando: type = countdown_collector
countdown_end_date	Opcional Corda	Disponível quando: type = countdown_collector
show_agreement	Opcional Booleano	Disponível quando: type = countdown_collector
agreement_text	Opcional Corda	Disponível quando: type = countdown_collector
agreement_url	Opcional Corda	Disponível quando: type = countdown_collector
thank_you_url	Opcional Corda	Disponível quando: type = countdown_collector
title_color	Opcional Corda	Disponível quando: type = countdown_collector
description_color	Opcional Corda	Disponível quando: type = countdown_collector
content_title_color	Opcional Corda	Disponível quando: type = countdown_collector
time_color	Opcional Corda	Disponível quando: type = countdown_collector
time_background_color	Opcional Corda	Disponível quando: type = countdown_collector
background_color	Opcional Corda	Disponível quando: type = countdown_collector
button_background_color	Opcional Corda	Disponível quando: type = countdown_collector
button_color	Opcional Corda	Disponível quando: type = countdown_collector
custom_html
html	Opcional Corda	Disponível quando: type = custom_html
background_color	Opcional Corda	Disponível quando: type = custom_html
informational_bar
title	Opcional Corda	Disponível quando: type = informational_bar
description	Opcional Corda	Disponível quando: type = informational_bar
image	Opcional Arquivo	Disponível quando: type = informational_bar
image_alt	Opcional Flutuar	Disponível quando: type = informational_bar
url	Opcional Flutuar	Disponível quando: type = informational_bar
url_new_tab	Opcional Booleano	Disponível quando: type = informational_bar
title_color	Opcional Corda	Disponível quando: type = informational_bar
description_color	Opcional Corda	Disponível quando: type = informational_bar
background_color	Opcional Corda	Disponível quando: type = informational_bar
informational_bar_mini
title	Opcional Corda	Disponível quando: type = informational_bar_mini
image	Opcional Arquivo	Disponível quando: type = informational_bar_mini
image_alt	Opcional Flutuar	Disponível quando: type = informational_bar_mini
url	Opcional Flutuar	Disponível quando: type = informational_bar_mini
url_new_tab	Opcional Booleano	Disponível quando: type = informational_bar_mini
title_color	Opcional Corda	Disponível quando: type = informational_bar_mini
description_color	Opcional Corda	Disponível quando: type = informational_bar_mini
background_color	Opcional Corda	Disponível quando: type = informational_bar_mini
image
title	Opcional Corda	Disponível quando: type = image
image	Opcional Arquivo	Disponível quando: type = image
image_alt	Opcional Corda	Disponível quando: type = image
button_url	Opcional Corda	Disponível quando: type = image
button_text	Opcional Corda	Disponível quando: type = image
title_color	Opcional Corda	Disponível quando: type = image
background_color	Opcional Corda	Disponível quando: type = image
button_background_color	Opcional Corda	Disponível quando: type = image
button_color	Opcional Corda	Disponível quando: type = image
collector_bar
title	Opcional Corda	Disponível quando: type = collector_bar
input_placeholder	Opcional Corda	Disponível quando: type = collector_bar
button_text	Opcional Corda	Disponível quando: type = collector_bar
show_agreement	Opcional Booleano	Disponível quando: type = collector_bar
agreement_text	Opcional Corda	Disponível quando: type = collector_bar
agreement_url	Opcional Corda	Disponível quando: type = collector_bar
thank_you_url	Opcional Corda	Disponível quando: type = collector_bar
title_color	Opcional Corda	Disponível quando: type = collector_bar
background_color	Opcional Corda	Disponível quando: type = collector_bar
button_background_color	Opcional Corda	Disponível quando: type = collector_bar
button_color	Opcional Corda	Disponível quando: type = collector_bar
coupon_bar
title	Opcional Corda	Disponível quando: type = coupon_bar
coupon_code	Opcional Corda	Disponível quando: type = coupon_bar
url	Opcional Flutuar	Disponível quando: type = coupon_bar
url_new_tab	Opcional Booleano	Disponível quando: type = coupon_bar
title_color	Opcional Corda	Disponível quando: type = coupon_bar
background_color	Opcional Corda	Disponível quando: type = coupon_bar
coupon_code_color	Opcional Corda	Disponível quando: type = coupon_bar
coupon_code_background_color	Opcional Corda	Disponível quando: type = coupon_bar
coupon_code_border_color	Opcional Corda	Disponível quando: type = coupon_bar
button_bar
title	Opcional Corda	Disponível quando: type = button_bar
button_text	Opcional Corda	Disponível quando: type = button_bar
url	Opcional Corda	Disponível quando: type = button_bar
url_new_tab	Opcional Booleano	Disponível quando: type = button_bar
title_color	Opcional Corda	Disponível quando: type = button_bar
background_color	Opcional Corda	Disponível quando: type = button_bar
button_color	Opcional Corda	Disponível quando: type = button_bar
button_background_color	Opcional Corda	Disponível quando: type = button_bar
collector_modal
title	Opcional Corda	Disponível quando: type = collector_modal
description	Opcional Corda	Disponível quando: type = collector_modal
image	Opcional Arquivo	Disponível quando: type = collector_modal
image_alt	Opcional Corda	Disponível quando: type = collector_modal
input_placeholder	Opcional Corda	Disponível quando: type = collector_modal
button_text	Opcional Corda	Disponível quando: type = collector_modal
show_agreement	Opcional Booleano	Disponível quando: type = collector_modal
agreement_text	Opcional Corda	Disponível quando: type = collector_modal
agreement_url	Opcional Corda	Disponível quando: type = collector_modal
thank_you_url	Opcional Corda	Disponível quando: type = collector_modal
title_color	Opcional Corda	Disponível quando: type = collector_modal
description_color	Opcional Corda	Disponível quando: type = collector_modal
background_color	Opcional Corda	Disponível quando: type = collector_modal
button_background_color	Opcional Corda	Disponível quando: type = collector_modal
button_color	Opcional Corda	Disponível quando: type = collector_modal
collector_two_modal
title	Opcional Corda	Disponível quando: type = collector_two_modal
description	Opcional Corda	Disponível quando: type = collector_two_modal
image	Opcional Arquivo	Disponível quando: type = collector_two_modal
image_alt	Opcional Corda	Disponível quando: type = collector_two_modal
input_placeholder	Opcional Corda	Disponível quando: type = collector_two_modal
button_text	Opcional Corda	Disponível quando: type = collector_two_modal
show_agreement	Opcional Booleano	Disponível quando: type = collector_two_modal
agreement_text	Opcional Corda	Disponível quando: type = collector_two_modal
agreement_url	Opcional Corda	Disponível quando: type = collector_two_modal
thank_you_url	Opcional Corda	Disponível quando: type = collector_two_modal
title_color	Opcional Corda	Disponível quando: type = collector_two_modal
description_color	Opcional Corda	Disponível quando: type = collector_two_modal
background_color	Opcional Corda	Disponível quando: type = collector_two_modal
button_background_color	Opcional Corda	Disponível quando: type = collector_two_modal
button_color	Opcional Corda	Disponível quando: type = collector_two_modal
button_modal
title	Opcional Corda	Disponível quando: type = button_modal
description	Opcional Corda	Disponível quando: type = button_modal
image	Opcional Arquivo	Disponível quando: type = button_modal
image_alt	Opcional Corda	Disponível quando: type = button_modal
button_text	Opcional Corda	Disponível quando: type = button_modal
button_url	Opcional Corda	Disponível quando: type = button_modal
url_new_tab	Opcional Booleano	Disponível quando: type = button_modal
title_color	Opcional Corda	Disponível quando: type = button_modal
description_color	Opcional Corda	Disponível quando: type = button_modal
background_color	Opcional Corda	Disponível quando: type = button_modal
button_background_color	Opcional Corda	Disponível quando: type = button_modal
button_color	Opcional Corda	Disponível quando: type = button_modal
text_feedback
title	Opcional Corda	Disponível quando: type = text_feedback
description	Opcional Corda	Disponível quando: type = text_feedback
input_placeholder	Opcional Corda	Disponível quando: type = text_feedback
button_text	Opcional Corda	Disponível quando: type = text_feedback
thank_you_url	Opcional Corda	Disponível quando: type = text_feedback
title_color	Opcional Corda	Disponível quando: type = text_feedback
description_color	Opcional Corda	Disponível quando: type = text_feedback
background_color	Opcional Corda	Disponível quando: type = text_feedback
button_background_color	Opcional Corda	Disponível quando: type = text_feedback
button_color	Opcional Corda	Disponível quando: type = text_feedback
engagement_links
title	Opcional Corda	Disponível quando: type = engagement_links
categories	Opcional Corda	Disponível quando: type = engagement_links
title_color	Opcional Corda	Disponível quando: type = text_feedback
categories_title_color	Opcional Corda	Disponível quando: type = text_feedback
categories_description_color	Opcional Corda	Disponível quando: type = text_feedback
categories_links_title_color	Opcional Corda	Disponível quando: type = text_feedback
categories_links_description_color	Opcional Corda	Disponível quando: type = text_feedback
categories_links_background_color	Opcional Corda	Disponível quando: type = text_feedback
categories_links_border_color	Opcional Corda	Disponível quando: type = text_feedback
background_color	Opcional Corda	Disponível quando: type = text_feedback
whatsapp_chat
title	Opcional Corda	Disponível quando: type = whatsapp_chat
agent_image	Opcional Arquivo	Disponível quando: type = whatsapp_chat
agent_image_alt	Opcional Corda	Disponível quando: type = whatsapp_chat
agent_name	Opcional Corda	Disponível quando: type = whatsapp_chat
agent_description	Opcional Corda	Disponível quando: type = whatsapp_chat
agent_message	Opcional Corda	Disponível quando: type = whatsapp_chat
agent_phone_number	Opcional Corda	Disponível quando: type = whatsapp_chat
button_text	Opcional Corda	Disponível quando: type = whatsapp_chat
header_agent_name_color	Opcional Corda	Disponível quando: type = whatsapp_chat
header_agent_description_color	Opcional Corda	Disponível quando: type = whatsapp_chat
header_background_color	Opcional Corda	Disponível quando: type = whatsapp_chat
content_background_color	Opcional Corda	Disponível quando: type = whatsapp_chat
content_agent_name_color	Opcional Corda	Disponível quando: type = whatsapp_chat
content_agent_message_color	Opcional Corda	Disponível quando: type = whatsapp_chat
content_agent_message_background_color	Opcional Corda	Disponível quando: type = whatsapp_chat
footer_background_color	Opcional Corda	Disponível quando: type = whatsapp_chat
footer_button_background_color	Opcional Corda	Disponível quando: type = whatsapp_chat
footer_button_color	Opcional Corda	Disponível quando: type = whatsapp_chat
title_color	Opcional Corda	Disponível quando: type = whatsapp_chat
background_color	Opcional Corda	Disponível quando: type = whatsapp_chat
contact_us
title	Opcional Corda	Disponível quando: type = contact_us
description	Opcional Corda	Disponível quando: type = contact_us
contact_email	Opcional Corda	Disponível quando: type = contact_us
contact_phone_number	Opcional Corda	Disponível quando: type = contact_us
contact_whatsapp	Opcional Corda	Disponível quando: type = contact_us
contact_telegram	Opcional Corda	Disponível quando: type = contact_us
contact_facebook_messenger	Opcional Corda	Disponível quando: type = contact_us
title_color	Opcional Corda	Disponível quando: type = contact_us
description_color	Opcional Corda	Disponível quando: type = contact_us
background_color	Opcional Corda	Disponível quando: type = contact_us

Exemplo

curl --request POST \
--url 'https://vortex.alyra.com.br/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=example' \
--form 'is_enabled=1'

Exemplo de resposta

{ "data": { "id": 1 } }

Excluir

Ponto de extremidade

DELETE https://vortex.alyra.com.br/api/notifications/{notification_id}

Exemplo

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