{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/campaigns","auth":"required","examples":{"codes":[{"code":"curl -X GET \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/campaigns\"\n\t-H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"","language":"shell"}]},"method":"get","params":[{"name":"app_id","type":"string","default":"","desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","required":true,"in":"path","ref":"","_id":"57ff811c7c80de0e00c56809"},{"name":"state","type":"string","default":"","desc":"Filters the campaigns by state. Available States are [active, draft, paused, stopped, scheduled]","required":false,"in":"query","ref":"","_id":"57cfd74da172c60e00a1ebee"},{"name":"allow_replay","type":"boolean","default":"null","desc":"Allow users to reply to this campaign. Must not be present for simple flow campaigns.","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabddd"},{"name":"broadcast_type","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabddc"},{"name":"campaign_expiry","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabddb"},{"name":"campaign_limits","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdda"},{"name":"created_at","type":"string","default":"","desc":"Date campaign was created at","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdd9"},{"name":"delivered_at","type":"string","default":"","desc":"Date campaign was delivered at","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdd8"},{"name":"delivery","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdd7"},{"name":"end_at","type":"string","default":"","desc":"Date at which the campaign will stop delivering","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdd6"},{"name":"expiry_date","type":"string","default":"null","desc":"The date to remove campaign's content from user's inbox. The date to stop campaign delivery. The acceptable format is: \"yyyy-mm-ddThh:nn:ss\" e.g. \"2016-05-14T13:15:00\". Must not be passed alongside with \"expiry_time_value\".","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdd5"},{"name":"expiry_time_frame","type":"string","default":"minutes","desc":"A unit of the time after which (from delivery) campaign's content will be removed from user's inbox. Ignored if \"expiry_date\" was passed.","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdd4"},{"name":"expiry_time_value","type":"int","default":"null","desc":"The time after which (from delivery) campaign's content will be removed from user's inbox. Must not be used alongside with \"expiry_date\".","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdd3"},{"name":"guid","type":"string","default":"","desc":"Unique Guid Identifier for campaign","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdd2"},{"name":"hidden","type":"boolean","default":"","desc":"Whether campaign is hidden in portal or not","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdd1"},{"name":"hidden_at","type":"string","default":"","desc":"Date on which campaign was hidden","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdd0"},{"name":"name","type":"string","default":"null","desc":"The name of the campaign.","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdcf"},{"name":"notification_template","type":"string","default":"null","desc":"","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdce"},{"name":"send_value","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdcd"},{"name":"start_at","type":"string","default":"current date","desc":"The date to start campaign delivery. The acceptable format is: \"yyyy-mm-ddThh:nn:ss\" e.g. \"2016-05-14T13:15:00\".","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdcc"},{"name":"time_frame","type":"string","default":"minutes","desc":"A unit of the time after which (from first delivery) user will be able to get the campaign again when meeting the criteria.","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdcb"},{"name":"time_value","type":"int","default":"null","desc":"The time after which (from first delivery) user will be able to get the campaign again when meeting the criteria.","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdca"},{"name":"time_zone_name","type":"string","default":"\"Etc/UTC\"","desc":"The time zone name for better campaign delivery setup. The list of available values can be found here: https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#time-zones-names","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdc9"},{"name":"time_zone_offset","type":"int","default":"","desc":"Timezone offset compared to UTC","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdc8"},{"name":"type","type":"string","default":"null","desc":"The campaign's type determining elements required or banned for creation. One of [\"CardPushNotificationCampaign\"].","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdc7"},{"name":"updated_at","type":"string","default":"","desc":"Last updated date of campaign","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdc6"},{"name":"push_notification","type":"object","default":"","desc":"Push notification associated with campaign (if applicable)","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdc5"},{"name":"push_notification.body_template","type":"string","default":"","desc":"Body of Push notification text","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdc4"},{"name":"sms_notification","type":"object","default":"","desc":"SMS notification associated with campaign (if applicable)","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdc3"},{"name":"sms_notification.body_template","type":"string","default":"","desc":"Body of sms notification associated with campaign (if applicable)","required":false,"in":"body","ref":"","_id":"5ece7dd50289970044e9f023"},{"name":"id","type":"string","default":"","desc":"Unique ID of campaign","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdc2"},{"name":"subscriptions_count","type":"int","default":"","desc":"Count of number of users associated with this campaign","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdc1"},{"name":"state","type":"string","default":"","desc":"Current state of campaign (Active, Delivered etc)","required":false,"in":"body","ref":"","_id":"5ece77a724493f0018dabdc0"}],"results":{"codes":[{"name":"","code":"[\n    {\n        \"allow_reply\": true,\n        \"broadcast_type\": \"segment\",\n        \"campaign_expiry\": true,\n        \"campaign_limits\": false,\n        \"created_at\": \"2018-04-25T13:41:44Z\",\n        \"delivered_at\": null,\n        \"delivery\": \"current\",\n        \"end_at\": null,\n        \"expiry_date\": null,\n        \"expiry_time_frame\": \"minutes\",\n        \"expiry_time_value\": 1,\n        \"guid\": \"-LNW2OF4\",\n        \"hidden\": false,\n        \"hidden_at\": null,\n        \"name\": \"Push Notification Campaign\",\n        \"notification_template\": \"Sample message to the user\",\n        \"send_value\": 1,\n        \"start_at\": \"2020-05-26T14:28:00+00:00\",\n        \"time_frame\": null,\n        \"time_value\": null,\n        \"time_zone_name\": \"Europe/Berlin\",\n        \"time_zone_offset\": \"2\",\n        \"type\": \"PushNotificationCampaign\",\n        \"updated_at\": \"2020-05-26T14:29:42Z\",\n        \"push_notification\": {\n            \"body_template\": \"Sample message to the user \"\n        },\n        \"sms_notification\": {\n            \"body_template\": \"Sample message to the user \"\n        },\n        \"id\": \"5ae085984753364a200b0000\",\n        \"subscriptions_count\": 1,\n        \"state\": \"initial\"\n    },\n    {\n        \"allow_reply\": true,\n        \"broadcast_type\": \"segment\",\n        \"campaign_expiry\": true,\n        \"campaign_limits\": false,\n        \"created_at\": \"2020-05-19T13:13:55Z\",\n        \"delivered_at\": null,\n        \"delivery\": \"current\",\n        \"end_at\": null,\n        \"expiry_date\": null,\n        \"expiry_time_frame\": \"weeks\",\n        \"expiry_time_value\": 1,\n        \"guid\": \"ZL-Ep-vz\",\n        \"hidden\": false,\n        \"hidden_at\": null,\n        \"name\": \"test\",\n        \"notification_template\": \"Sample message to the user\",\n        \"send_value\": 1,\n        \"start_at\": \"2020-05-25T14:28:00+00:00\",\n        \"time_frame\": null,\n        \"time_value\": null,\n        \"time_zone_name\": \"Etc/UTC\",\n        \"time_zone_offset\": \"+00:00\",\n        \"type\": \"PushNotificationCampaign\",\n        \"updated_at\": \"2020-05-25T12:28:48Z\",\n        \"push_notification\": {\n            \"body_template\": \"Sample message to the user \"\n        },\n        \"sms_notification\": {\n            \"body_template\": \"Sample message to the user \"\n        },\n        \"id\": \"5ec3db92536b7932ed090000\",\n        \"subscriptions_count\": 0,\n        \"state\": \"initial\"\n    },\n    {\n        \"allow_reply\": true,\n        \"broadcast_type\": \"segment\",\n        \"campaign_expiry\": false,\n        \"campaign_limits\": false,\n        \"created_at\": \"2020-05-26T10:36:35Z\",\n        \"delivered_at\": null,\n        \"delivery\": \"current\",\n        \"end_at\": null,\n        \"expiry_date\": null,\n        \"expiry_time_frame\": \"weeks\",\n        \"expiry_time_value\": 1,\n        \"guid\": \"JyEBUz5q\",\n        \"hidden\": false,\n        \"hidden_at\": null,\n        \"name\": \"test\",\n        \"notification_template\": \"Sample message to the user\",\n        \"send_value\": 1,\n        \"start_at\": \"2020-05-26T10:36:00+00:00\",\n        \"time_frame\": null,\n        \"time_value\": null,\n        \"time_zone_name\": \"Europe/Berlin\",\n        \"time_zone_offset\": \"2\",\n        \"type\": \"PushNotificationCampaign\",\n        \"updated_at\": \"2020-05-26T10:36:35Z\",\n        \"push_notification\": {\n            \"body_template\": \"Sample message to the user \"\n        },\n        \"sms_notification\": {\n            \"body_template\": \"Sample message to the user \"\n        },\n        \"id\": \"5eccf133536b7929be100000\",\n        \"subscriptions_count\": 0,\n        \"state\": \"initial\"\n    },\n    {\n        \"allow_reply\": true,\n        \"broadcast_type\": \"segment\",\n        \"campaign_expiry\": true,\n        \"campaign_limits\": false,\n        \"created_at\": \"2020-05-26T13:50:43Z\",\n        \"delivered_at\": null,\n        \"delivery\": \"current\",\n        \"end_at\": null,\n        \"expiry_date\": null,\n        \"expiry_time_frame\": \"weeks\",\n        \"expiry_time_value\": 1,\n        \"guid\": \"qDr270S_\",\n        \"hidden\": false,\n        \"hidden_at\": null,\n        \"name\": \"kupa23\",\n        \"notification_template\": \"Sample message to the user\",\n        \"send_value\": 1,\n        \"start_at\": \"2020-05-26T13:52:00+00:00\",\n        \"time_frame\": null,\n        \"time_value\": null,\n        \"time_zone_name\": \"Europe/Berlin\",\n        \"time_zone_offset\": \"2\",\n        \"type\": \"PushNotificationCampaign\",\n        \"updated_at\": \"2020-05-26T13:52:23Z\",\n        \"push_notification\": {\n            \"body_template\": \"Sample message to the user \"\n        },\n        \"sms_notification\": {\n            \"body_template\": \"Sample message to the user \"\n        },\n        \"id\": \"5ecd1eb3536b794ca60c0000\",\n        \"subscriptions_count\": 0,\n        \"state\": \"initial\"\n    }\n]","language":"json","status":200}]},"settings":"564bbbf80cbcc91700b8171c"},"next":{"description":"","pages":[]},"title":"Campaigns: Get All (Index)","type":"endpoint","slug":"campaigns-get-list","excerpt":"","body":"","updates":[],"order":17,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d28eb","user":"57a45e5726785a0e00b69a49","__v":12,"githubsync":"","version":{"version":"2.2","version_clean":"2.2.0","codename":"CMS API","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e4fced159815700262d2899","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","5e4fced159815700262d289a","5e4fced159815700262d289b","5e4fced159815700262d289c","5e4fced159815700262d289d","5e4fced159815700262d289e","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","5e4fced159815700262d289f","5e4fced159815700262d28a0","5c73dd27e8fdc000572a206a","5e4fced159815700262d28a1","5e53c04c1d11110018b56e12"],"_id":"5e4fced159815700262d2930","project":"54aa7f773b56130b0056c86e","forked_from":"55781fe25129590d003ff4f7","__v":1,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["5e4fced159815700262d28c6","5e4fced159815700262d28c7","5e4fced159815700262d28c8","5e4fced159815700262d28c9","5e4fced159815700262d28ca","5e4fced159815700262d28cb","5e4fced159815700262d28cc","5e4fced159815700262d28cd","5e4fced159815700262d28ce","564c68a93eb8f81700838a25"],"title":"Pulsate CMS API","slug":"pulsate-cms-api","order":1,"from_sync":false,"reference":true,"_id":"5e4fced159815700262d289e","__v":10,"createdAt":"2015-11-17T23:47:10.058Z","project":"54aa7f773b56130b0056c86e","version":"5e4fced159815700262d2930"},"createdAt":"2016-09-07T09:01:01.009Z","parentDoc":null,"project":"54aa7f773b56130b0056c86e"}

getCampaigns: Get All (Index)


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App ID. It can be fetched by using "Apps: Get All (Index)" or "Apps: Get One (Show)" endpoints.

Query Params

state:
string
Filters the campaigns by state. Available States are [active, draft, paused, stopped, scheduled]

Body Params

allow_replay:
booleannull
Allow users to reply to this campaign. Must not be present for simple flow campaigns.
broadcast_type:
string
campaign_expiry:
boolean
campaign_limits:
boolean
created_at:
string
Date campaign was created at
delivered_at:
string
Date campaign was delivered at
delivery:
string
end_at:
string
Date at which the campaign will stop delivering
expiry_date:
stringnull
The date to remove campaign's content from user's inbox. The date to stop campaign delivery. The acceptable format is: "yyyy-mm-ddThh:nn:ss" e.g. "2016-05-14T13:15:00". Must not be passed alongside with "expiry_time_value".
expiry_time_frame:
stringminutes
A unit of the time after which (from delivery) campaign's content will be removed from user's inbox. Ignored if "expiry_date" was passed.
expiry_time_value:
integernull
The time after which (from delivery) campaign's content will be removed from user's inbox. Must not be used alongside with "expiry_date".
guid:
string
Unique Guid Identifier for campaign
hidden:
boolean
Whether campaign is hidden in portal or not
hidden_at:
string
Date on which campaign was hidden
name:
stringnull
The name of the campaign.
notification_template:
stringnull
send_value:
integer
start_at:
stringcurrent date
The date to start campaign delivery. The acceptable format is: "yyyy-mm-ddThh:nn:ss" e.g. "2016-05-14T13:15:00".
time_frame:
stringminutes
A unit of the time after which (from first delivery) user will be able to get the campaign again when meeting the criteria.
time_value:
integernull
The time after which (from first delivery) user will be able to get the campaign again when meeting the criteria.
time_zone_name:
string"Etc/UTC"
The time zone name for better campaign delivery setup. The list of available values can be found here: https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#time-zones-names
time_zone_offset:
integer
Timezone offset compared to UTC
type:
stringnull
The campaign's type determining elements required or banned for creation. One of ["CardPushNotificationCampaign"].
updated_at:
string
Last updated date of campaign
push_notification:
object
Push notification associated with campaign (if applicable)
push_notification.body_template:
string
Body of Push notification text
sms_notification:
object
SMS notification associated with campaign (if applicable)
sms_notification.body_template:
string
Body of sms notification associated with campaign (if applicable)
id:
string
Unique ID of campaign
subscriptions_count:
integer
Count of number of users associated with this campaign
state:
string
Current state of campaign (Active, Delivered etc)

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}