Segment usage
Project defined events
Employees
Businesses
Variables
Customers
- GETList all customers for a business
- POSTCreate a customer
- POSTCreate multiple customers
- POSTUpdate multiple customers
- GETRetrieve a customer
- POSTUpdate a customer
- DELDelete a customer
- POSTUnsubscribe a customer from campaigns and triggers
- GETRetrieve unsubscribe info for a customer
- POSTResubscribe a customer to campaigns and triggers
- GETRetrieve the segments a customer belongs to
Segments
Unsubscribe embeds
Email templates
- GETList all email templates for a business
- POSTCreate an email template
- POSTCreate a new email template using AI
- GETRetrieve an email template
- POSTUpdate an email template
- DELDelete an email template
- GETPreview an email template as an image
- GETPreview an email template
- POSTCreate a copy of an existing email template
- POSTCopy an email template as a one-off
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
Campaign embeds
Triggers
Trigger embeds
Email blasts
Project email addresses
Project phone numbers
Campaign templates
Trigger templates
Filter definitions
Sync
Reviews
Review embeds
Rewards programs
Location members
Locations
Promotions
Rewards profiles
Embeds
Feature flags
- GETGet the status of multiple feature flags for a business
- GETCheck if a feature flag is enabled for a business
- POSTCreate or update a feature flag override for a business
- DELDestroy a feature flag override for a business
- POSTCreate or update a feature flag override for a project
- DELDestroy a feature flag override for a project
Introduction
The complete API reference for the Pocketflows customer engagement API
This API is rapidly expanding and changing and may be subject to sudden breaking changes. Keep in touch with the team at team@pocketflows.com.
Welcome
This is the full Pocketflows embedded API. Use this API to power your customer engagement suite!
Authentication
All API endpoints are authenticated using Basic HTTP authentication. See the your dashboard for your project_id and secret_key. Pass the project_id and secret_key as username and password in Basic HTTP authentication.
On this page
Assistant
Responses are generated using AI and may contain mistakes.