Preview a campaign

Pocketflows

The complete API reference for the Pocketflows customer engagement API

Introduction

Idempotency Keys

Error codes and messsages from the Pocketflows API

Errors

Sync Overview

Embeds Overview

List the available steps for a project

Retrieve a project

Retrieve the segment usage for a business

List all project-defined events

Create a project defined event

Retrieve a project-defined event

Update a project defined event

Delete a project-defined event

List the types of all variables associated with the project-defined event

Track an event occuring within a business

Create a flow

Embed a flow

Embed an analytics flow

List all an employee's emails

List all employees for a business

Create an employee

Retrieve an employee

Update an employee

Delete an employee

List all businesses

Create a business

Retrieve a business

Update a business

Delete a business

Get the Google OAuth URL for a business

Get the connected accounts for a business

Get all variables for a business

Get all variables for an email template

Get all variables for an SMS template

List all customers for a business

Create a customer

Create multiple customers

Update multiple customers

Retrieve a customer

Update a customer

Delete a customer

Unsubscribe a customer from campaigns and triggers

Retrieve unsubscribe info for a customer

Resubscribe a customer to campaigns and triggers

Retrieve the segments a customer belongs to

List all the business's segments

Create a segment

Retrieve a segment

Update a segment

Delete a segment

Show the customers in a segment

Add a customer to a segment

Remove a customer from a segment

Create an unsubscribe embed

Retrieve an unsubscribe embed

Embed the unsubscribe form

List all email templates for a business

Create an email template

Create a new email template using AI

Retrieve an email template

Update an email template

Delete an email template

Preview an email template as an image

Preview an email template

Create a copy of an existing email template

Copy an email template as a one-off

Create an email template embed to edit an existing email template

Create an email template embed to create a brand new email template

Retrieve an email template embed

Embed the email template editor

List all project email templates

Retrieve a project email template

Preview a project email template as an image

Preview a project email template

Copy a project email template into a specific business

Copy a project email template into a specific business as a one-off template

Draft send an email based off an email template

Send an email based off an email template

Send an email

Retrieve the email addresses for a business

Retrieve a connected email address

Update an email address

Delete a connected email address

List all connected email addresses for an employee

Connect a Gmail to an employee

List all SMS templates for a business

Create an SMS template

Retrieve an SMS template

Update an SMS template

Delete an SMS template

Preview an SMS template as an image

Preview an SMS template

Create an SMS template embed to edit an existing SMS template

Create an SMS template embed to create a brand new SMS template

Retrieve an SMS template embed

Embed the SMS template editor

Draft send an SMS message from an SMS template

Send an SMS based off an SMS template

List all campaigns

Create a campaign

Retrieve a campaign

Update a campaign

Delete a campaign

Start a campaign

Stop a campaign

Schedule a campaign to begin

Preview a campaign as an image

View a campaign interactively

Create a campaign draft from a campaign template

Get the executions of a campaign

Get all variables associated with a campaign's steps

Create a campaign embed to create a new campaign

Create a campaign embed

Embed the campaign editor

Retrieve a campaign embed

List triggers for a business

Create a trigger

Retrieve a trigger

Update a trigger

Delete a trigger

Activate a trigger

Deactivate a trigger

Get the executions of a trigger

Create a trigger draft from a trigger template

View a trigger interactively

Create a trigger embed to create a new trigger

Create a trigger embed

Retrieve a trigger embed

Embed the trigger editor

List all email blasts

Create an email blast

Retrieve an email blast

Update an email blast

Delete an email blast

Start an email blast

Stop an email blast

Schedule an email blast

Get the executions of an email blast

Get all the enrolled customers for an email blast

List all project email addresses

Retrieve a project email address

List all project phone numbers

Retrieve a project phone number

Retrieve all campaign templates

Retrieve a campaign template

Update a campaign template

Retrieve all trigger templates

Retrieve a trigger template

Update a trigger template

List all phone numbers for a business

Retrieve a phone number

List all filter definitions

Create a filter definition

Retrieve a filter definition

Update a filter definition

Delete a filter definition

Enable a filter definition

Disable a filter definition

Sync a business

Sync a batch of businesses

Sync a customer

Sync a batch of customers

Retrieve the reviews for a business

Create a review for a business

Retrieve a review

Respond to a review

Create a review embed

Retrieve a review embed

Render the user experience of a review embed

Retrieve a business's configuration of the review embed

Create or update a review embed config

List all rewards programs

Retrieve a rewards program

Update a rewards program

Show a business's rewards program

Create a rewards program

List all members for a rewards program

Create a member

Retrieve a member

List all location members

Create a new location member

Retrieve a location member

List the locations under a rewards program

List all locations

Create a location

Retrieve a location

Update a location

List all tiers

Create a tier

Update a tier

List promotions for a rewards program

Create a promotion

Show a promotion

Update a promotion

Delete a promotion

Show a customer's rewards profile

Show all rewards profiles

Welcome

Core Concepts

Preview a campaign

Path Parameters

Response