Install our app Click on the icon in the top right of the address bar.
Start free

Campaigns

List All

GET https://pulse.pylogix.com/api/campaigns/
curl --request GET \
--url 'https://pulse.pylogix.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Request Parameters Details Description
page Optional Parameter Integer (Number) Page Number
results_per_page Optional Parameter Integer (Number) Results per Page
{ "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, "segment": "all", "settings": { "is_scheduled": 0, "ttl": 2419200, "urgency": "normal", "is_silent": 0, "is_auto_hide": 0, "button_title_1": "", "button_url_1": "", "button_title_2": "", "button_url_2": "" }, "subscribers_ids": [ 1,2,3,4,5 ], "sent_subscribers_ids": [], "total_sent_push_notifications": 0, "total_push_notifications": 1, "total_displayed_push_notifications": 0, "total_clicked_push_notifications": 0, "total_closed_push_notifications": 0, "status": "draft", "scheduled_datetime": "2024-08-09 00:16:22", "last_sent_datetime": null, "last_datetime": null, "datetime": "2026-11-09 18:15:46" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://pulse.pylogix.com/api/campaigns?&page=1", "last": "https://pulse.pylogix.com/api/campaigns?&page=1", "next": null, "prev": null, "self": "https://pulse.pylogix.com/api/campaigns?&page=1" } }

Get Details

GET https://pulse.pylogix.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://pulse.pylogix.com/api/campaigns/{campaign_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, "segment": "all", "settings": { "is_scheduled": 0, "ttl": 2419200, "urgency": "normal", "is_silent": 0, "is_auto_hide": 0, "button_title_1": "", "button_url_1": "", "button_title_2": "", "button_url_2": "" }, "subscribers_ids": [ 1,2,3,4,5 ], "sent_subscribers_ids": [], "total_sent_push_notifications": 0, "total_push_notifications": 1, "total_displayed_push_notifications": 0, "total_clicked_push_notifications": 0, "total_closed_push_notifications": 0, "status": "draft", "scheduled_datetime": "2024-08-09 00:16:22", "last_sent_datetime": null, "last_datetime": null, "datetime": "2026-11-09 18:15:46" } }

Create New

POST https://pulse.pylogix.com/api/campaigns
Request Parameters Details Description
website_id Required Parameter Integer (Number) -
name Required Parameter Text (String) -
title Required Parameter Text (String) -
description Required Parameter Text (String) -
url Optional Parameter Text (String) -
image Optional Parameter File Upload -
button_title_1 Optional Parameter Text (String) -
button_url_1 Optional Parameter Text (String) -
button_title_2 Optional Parameter Text (String) -
button_url_2 Optional Parameter Text (String) -
is_scheduled Optional Parameter Boolean (True/False) -
scheduled_datetime Optional Parameter Text (String) -
is_silent Optional Parameter Boolean (True/False) -
is_auto_hide Optional Parameter Boolean (True/False) -
ttl Optional Parameter Text (String) Allowed values: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
segment Optional Parameter Text (String) Allowed values: all , custom , filter , INT segment_id
subscribers_ids Optional Parameter Text (String) Available when: segment = custom
filters_custom_parameter_key[index] Optional Parameter Text (String) Available when: segment = filter
filters_custom_parameter_value[index] Optional Parameter Text (String) Available when: segment = filter
filters_custom_parameter_value[index] Optional Parameter Text (String) Available when: segment = filter
filters_subscribed_on_url Optional Parameter Text (String) Available when: segment = filter
filters_cities Optional Parameter Text (String) Available when: segment = filter
filters_countries[] Optional Parameter Text (String) Available when: segment = filter
filters_continents[] Optional Parameter Text (String) Available when: segment = filter
filters_device_type[] Optional Parameter Text (String) Available when: segment = filter
filters_languages[] Optional Parameter Text (String) Available when: segment = filter
filters_operating_systems[] Optional Parameter Text (String) Available when: segment = filter
filters_browsers[] Optional Parameter Text (String) Available when: segment = filter
utm_source Optional Parameter Text (String) -
utm_medium Optional Parameter Text (String) -
utm_campaign Optional Parameter Text (String) -
save Optional Parameter Boolean (True/False) Save draft
send Optional Parameter Boolean (True/False) Send campaign
curl --request POST \
--url 'https://pulse.pylogix.com/api/campaigns' \
--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' \
{ "data": { "id": 1 } }

Update Existing

POST https://pulse.pylogix.com/api/campaigns/{campaign_id}
Request Parameters Details Description
website_id Optional Parameter Integer (Number) -
name Optional Parameter Text (String) -
title Optional Parameter Text (String) -
description Optional Parameter Text (String) -
url Optional Parameter Text (String) -
image Optional Parameter File Upload -
button_title_1 Optional Parameter Text (String) -
button_url_1 Optional Parameter Text (String) -
button_title_2 Optional Parameter Text (String) -
button_url_2 Optional Parameter Text (String) -
is_scheduled Optional Parameter Boolean (True/False) -
scheduled_datetime Optional Parameter Text (String) -
is_silent Optional Parameter Boolean (True/False) -
is_auto_hide Optional Parameter Boolean (True/False) -
ttl Optional Parameter Text (String) Allowed values: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
segment Optional Parameter Text (String) Allowed values: all , custom , filter , INT segment_id
subscribers_ids Optional Parameter Text (String) Available when: segment = custom
filters_custom_parameter_key[index] Optional Parameter Text (String) Available when: segment = filter
filters_custom_parameter_value[index] Optional Parameter Text (String) Available when: segment = filter
filters_custom_parameter_value[index] Optional Parameter Text (String) Available when: segment = filter
filters_subscribed_on_url Optional Parameter Text (String) Available when: segment = filter
filters_cities Optional Parameter Text (String) Available when: segment = filter
filters_countries[] Optional Parameter Text (String) Available when: segment = filter
filters_continents[] Optional Parameter Text (String) Available when: segment = filter
filters_device_type[] Optional Parameter Text (String) Available when: segment = filter
filters_languages[] Optional Parameter Text (String) Available when: segment = filter
filters_operating_systems[] Optional Parameter Text (String) Available when: segment = filter
filters_browsers[] Optional Parameter Text (String) Available when: segment = filter
utm_source Optional Parameter Text (String) -
utm_medium Optional Parameter Text (String) -
utm_campaign Optional Parameter Text (String) -
save Optional Parameter Boolean (True/False) Save draft
send Optional Parameter Boolean (True/False) Send campaign
curl --request POST \
--url 'https://pulse.pylogix.com/api/campaigns/{campaign_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' \
{ "data": { "id": 1 } }

Delete Item

DELETE https://pulse.pylogix.com/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://pulse.pylogix.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \