Endpoints
- Projects
- Segment usage
- Project defined events
- Events
- Flows
- Employees
- Businesses
- Variables
- Customers
- Segments
- Unsubscribe embeds
- Email templates
- Email template embeds
- Project email templates
- Emails
- Email addresses
- Sms templates
- Sms template embeds
- Sms messages
- Campaigns
- GETList all campaigns
- POSTCreate a campaign
- GETRetrieve a campaign
- POSTUpdate a campaign
- DELDelete a campaign
- POSTStart a campaign
- POSTStop a campaign
- POSTSchedule a campaign to begin
- GETPreview a campaign as an image
- GETPreview a campaign
- GETView a campaign interactively
- POSTCreate a campaign draft from a campaign template
- GETGet the executions of a campaign
- GETGet all variables associated with a campaign's steps
- GET
- Campaign embeds
- Triggers
- Trigger embeds
- Email blasts
- Project email addresses
- Project phone numbers
- Campaign templates
- Trigger templates
- Phone numbers
- Filter definitions
- Sync
- Reviews
- Review embeds
- Rewards programs
- Members
- Location members
- Locations
- Tiers
- Promotions
- Rewards profiles
- Users
- Embeds
- Feature flags
Campaigns
Start a campaign
POST
/
campaigns
/
{id}
/
start
Copy
curl --request POST \
--url https://api.pocketflows.com/campaigns/{id}/start \
--header 'Authorization: Basic <encoded-value>'
Copy
{
"id": "<string>",
"name": "<string>",
"enrolled_customers": [
"<string>"
],
"segment": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"email_address": "<string>",
"phone_number": "<string>",
"status": "draft",
"scheduled_at": "<string>",
"statistics": {
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"consumed_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"estimated_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"attributed_revenue": 123
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
The ID of the campaign
Response
200 - application/json
The Campaign
object
The response is of type object
.
Copy
curl --request POST \
--url https://api.pocketflows.com/campaigns/{id}/start \
--header 'Authorization: Basic <encoded-value>'
Copy
{
"id": "<string>",
"name": "<string>",
"enrolled_customers": [
"<string>"
],
"segment": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"email_address": "<string>",
"phone_number": "<string>",
"status": "draft",
"scheduled_at": "<string>",
"statistics": {
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"consumed_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"estimated_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"attributed_revenue": 123
}
Assistant
Responses are generated using AI and may contain mistakes.