Flows

Retrieve all

GET https://freepush.cc/api/flows/
curl --request GET \
--url 'https://freepush.cc/api/flows/' \
--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, "user_id": 1, "website_id": 1, "name": "API Sample", "title": "Sample message", "description": "This is coming from the API.", "url": "https://example.com", "image_url": null, "settings": { "ttl": 2419200, "urgency": "normal", "is_silent": 0, "is_auto_hide": 0, "button_title_1": "", "button_url_1": "", "button_title_2": "", "button_url_2": "" }, "wait_time": 3, "wait_time_type": "days", "is_enabled": true, "total_sent_push_notifications": 0, "total_displayed_push_notifications": 0, "total_clicked_push_notifications": 0, "total_closed_push_notifications": 0, "last_sent_datetime": null, "last_datetime": null, "datetime": "2024-07-18 03:55:10" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://freepush.cc/api/flows?&page=1", "last": "https://freepush.cc/api/flows?&page=1", "next": null, "prev": null, "self": "https://freepush.cc/api/flows?&page=1" } }

Retrieve one

GET https://freepush.cc/api/flows/{flow_id}
curl --request GET \
--url 'https://freepush.cc/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "user_id": 1, "website_id": 1, "name": "API Sample", "title": "Sample message", "description": "This is coming from the API.", "url": "https://example.com", "image_url": null, "settings": { "ttl": 2419200, "urgency": "normal", "is_silent": 0, "is_auto_hide": 0, "button_title_1": "", "button_url_1": "", "button_title_2": "", "button_url_2": "" }, "wait_time": 3, "wait_time_type": "days", "is_enabled": true, "total_sent_push_notifications": 0, "total_displayed_push_notifications": 0, "total_clicked_push_notifications": 0, "total_closed_push_notifications": 0, "last_sent_datetime": null, "last_datetime": null, "datetime": "2024-07-18 03:55:10" } }

Create

POST https://freepush.cc/api/flows
Parameters Details Description
website_id Required Integer -
name Required String -
title Required String -
description Required String -
url Optional String -
image Optional File -
wait_time Required Integer -
wait_time_type Required String Allowed values: minutes , hours , days
button_title_1 Optional String -
button_url_1 Optional String -
button_title_2 Optional String -
button_url_2 Optional String -
is_silent Optional Boolean -
is_auto_hide Optional Boolean -
ttl Optional String Allowed values: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
curl --request POST \
--url 'https://freepush.cc/api/flows' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
{ "data": { "id": 1 } }

Update

POST https://freepush.cc/api/flows/{flow_id}
Parameters Details Description
website_id Optional Integer -
name Optional String -
title Optional String -
description Optional String -
url Optional String -
image Optional File -
wait_time Optional Integer -
wait_time_type Optional String Allowed values: minutes , hours , days
button_title_1 Optional String -
button_url_1 Optional String -
button_title_2 Optional String -
button_url_2 Optional String -
is_silent Optional Boolean -
is_auto_hide Optional Boolean -
ttl Optional String Allowed values: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
curl --request POST \
--url 'https://freepush.cc/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
{ "data": { "id": 1 } }

Delete

DELETE https://freepush.cc/api/flows/{flow_id}
curl --request DELETE \
--url 'https://freepush.cc/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \