Endpoints
- 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
- POSTTest-send a campaign
- POSTCheck the sendability of a campaign
- GETGet all variables associated with a campaign's steps
- POSTCreate a campaign draft from a campaign template
- GET
curl --request GET \
--url https://api.pocketflows.com/businesses/{id}/campaigns \
--header 'Authorization: Basic <encoded-value>'{
"campaigns": [
{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"business": "<string>",
"name": "<string>",
"segment": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"email_address": "<string>",
"phone_number": "<string>",
"status": "draft",
"scheduled_at": "<string>",
"scheduled_end_at": "<string>",
"statistics": {
"emails": {
"sent": 123,
"delivered": 123,
"opened": 123,
"soft_bounced": 123,
"hard_bounced": 123,
"clicked": 123
},
"custom_steps": [
{
"custom_step": "<string>",
"sent": 123
}
],
"executions": {
"total": 123,
"pending": 123,
"started": 123,
"finished": 123,
"errored": 123
},
"sms": {
"sms_sent_count": 123,
"sms_sent_segments_count": 123,
"mms_sent_count": 123,
"mms_sent_segments_count": 123
},
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"consumed_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"attributed_revenue": "<string>",
"metadata": {},
"enrolled_customers": [
"<string>"
],
"estimated_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
}
}
]
}List all campaigns
curl --request GET \
--url https://api.pocketflows.com/businesses/{id}/campaigns \
--header 'Authorization: Basic <encoded-value>'{
"campaigns": [
{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"business": "<string>",
"name": "<string>",
"segment": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"email_address": "<string>",
"phone_number": "<string>",
"status": "draft",
"scheduled_at": "<string>",
"scheduled_end_at": "<string>",
"statistics": {
"emails": {
"sent": 123,
"delivered": 123,
"opened": 123,
"soft_bounced": 123,
"hard_bounced": 123,
"clicked": 123
},
"custom_steps": [
{
"custom_step": "<string>",
"sent": 123
}
],
"executions": {
"total": 123,
"pending": 123,
"started": 123,
"finished": 123,
"errored": 123
},
"sms": {
"sms_sent_count": 123,
"sms_sent_segments_count": 123,
"mms_sent_count": 123,
"mms_sent_segments_count": 123
},
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"consumed_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"attributed_revenue": "<string>",
"metadata": {},
"enrolled_customers": [
"<string>"
],
"estimated_message_segments": {
"sms": 123,
"mms": 123,
"email": 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 business
Response
A dictionary with a campaigns property which is an array of Campaign objects
An array of campaigns
Show child attributes
Show child attributes
The ID of the campaign
The time when the campaign was created in ISO 8601 format
The time when the campaign was last updated in ISO 8601 format
The ID of the business
The name of the campaign
The segment attached to the campaign
The steps of the campaign
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
The step type. Always "email" for this step
email The ID of the email template to use in this step
Optional. The ID of the custom step to use in this step. The type of the custom step must be "email" as well
The email address used to send emails in the campaign. Will be the ID of an email-like object
The phone number used to send SMS messages in the campaign. Will be the ID of a phone number-like object
The status of the campaign.
draft, scheduled, started, stopped, finished The time when the campaign is scheduled to start in ISO 8601 format
The time when the campaign is scheduled to end in ISO 8601 format
The statistics of the campaign. Includes information about customers enrolled, email statistics, and custom step statistics
Show child attributes
Show child attributes
Email statistics including sent, delivered, opened, bounced, and clicked counts
Show child attributes
Show child attributes
The number of emails sent
The number of emails delivered
The number of emails opened
The number of emails that soft bounced
The number of emails that hard bounced
The number of emails clicked (null if tracking not enabled)
Execution statistics
Show child attributes
Show child attributes
Total number of executions
Number of pending executions
Number of started executions
Number of finished executions
Number of errored executions
SMS statistics
Show child attributes
Show child attributes
The number of SMS messages sent
The number of SMS messages segments
The number of MMS messages sent
The number of MMS messages segments
The number of customers enrolled in the campaign or trigger
The number of customers who have started receiving messages
The number of customers who have finished receiving all the messages
The number of message segments actually used by the campaign
The revenue attributed to the campaign
Arbitrary metadata associated with this campaign
The customers enrolled in the campaign
The number of message segments estimated to be used by the campaign