Campaigns
GET https://app.pusherstudio.com/api/campaigns/
curl --request GET \
--url 'https://app.pusherstudio.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://app.pusherstudio.com/api/campaigns/' \
--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,
"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": "2024-08-09 00:16:22"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://app.pusherstudio.com/api/campaigns?&page=1",
"last": "https://app.pusherstudio.com/api/campaigns?&page=1",
"next": null,
"prev": null,
"self": "https://app.pusherstudio.com/api/campaigns?&page=1"
}
}
GET https://app.pusherstudio.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://app.pusherstudio.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://app.pusherstudio.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": "2024-08-09 00:16:22"
}
}
POST https://app.pusherstudio.com/api/campaigns
| Parameters | Details | Description |
|---|---|---|
| website_id | Required Integer | - |
| name | Required String | - |
| title | Required String | - |
| description | Required String | - |
| url | Optional String | - |
| image | Optional File | - |
| button_title_1 | Optional String | - |
| button_url_1 | Optional String | - |
| button_title_2 | Optional String | - |
| button_url_2 | Optional String | - |
| is_scheduled | Optional Boolean | - |
| scheduled_datetime | 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 |
| segment | Optional String | Allowed values: all , custom , filter , INT segment_id |
| subscribers_ids | Optional String | Available when: segment = custom |
| filters_custom_parameter_key[index] | Optional String | Available when: segment = filter |
| filters_custom_parameter_value[index] | Optional String | Available when: segment = filter |
| filters_custom_parameter_value[index] | Optional String | Available when: segment = filter |
| filters_cities[] | Optional String | Available when: segment = filter |
| filters_countries[] | Optional String | Available when: segment = filter |
| filters_continents[] | Optional String | Available when: segment = filter |
| filters_device_type[] | Optional String | Available when: segment = filter |
| filters_languages[] | Optional String | Available when: segment = filter |
| filters_operating_systems[] | Optional String | Available when: segment = filter |
| filters_browsers[] | Optional String | Available when: segment = filter |
| save | Optional Boolean | Save draft |
| send | Optional Boolean | Send campaign |
curl --request POST \
--url 'https://app.pusherstudio.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' \
--url 'https://app.pusherstudio.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
}
}
POST https://app.pusherstudio.com/api/campaigns/{campaign_id}
| Parameters | Details | Description |
|---|---|---|
| website_id | Optional Integer | - |
| name | Optional String | - |
| title | Optional String | - |
| description | Optional String | - |
| url | Optional String | - |
| image | Optional File | - |
| button_title_1 | Optional String | - |
| button_url_1 | Optional String | - |
| button_title_2 | Optional String | - |
| button_url_2 | Optional String | - |
| is_scheduled | Optional Boolean | - |
| scheduled_datetime | 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 |
| segment | Optional String | Allowed values: all , custom , filter , INT segment_id |
| subscribers_ids | Optional String | Available when: segment = custom |
| filters_custom_parameter_key[index] | Optional String | Available when: segment = filter |
| filters_custom_parameter_value[index] | Optional String | Available when: segment = filter |
| filters_custom_parameter_value[index] | Optional String | Available when: segment = filter |
| filters_cities[] | Optional String | Available when: segment = filter |
| filters_countries[] | Optional String | Available when: segment = filter |
| filters_continents[] | Optional String | Available when: segment = filter |
| filters_device_type[] | Optional String | Available when: segment = filter |
| filters_languages[] | Optional String | Available when: segment = filter |
| filters_operating_systems[] | Optional String | Available when: segment = filter |
| filters_browsers[] | Optional String | Available when: segment = filter |
| save | Optional Boolean | Save draft |
| send | Optional Boolean | Send campaign |
curl --request POST \
--url 'https://app.pusherstudio.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' \
--url 'https://app.pusherstudio.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 https://app.pusherstudio.com/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://app.pusherstudio.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://app.pusherstudio.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \