The Segment object

<string>

Pocketflows

The complete API reference for the Pocketflows customer engagement API

Introduction

Idempotency Keys

Error codes and messsages from the Pocketflows API

Errors

The Business object

List all businesses

Create a business

Retrieve a business

Update a business

Delete a business

Retrieve the segment usage for a business

The Customer object

List all customers for a business

Create a customer

Retrieve a customer

Update a customer

Unsubscribe a customer from campaigns and triggers

Resubscribe a customer to campaigns and triggers

Delete a customer

Create multiple customers

Update multiple customers

List all the business's segments

Create a segment

Retrieve a segment

Add a customer to a segment

Remove a customer from a segment

Delete a segment

The Employee object

List all employees for a business

Create an employee

Retrieve an employee

Update an employee

Delete an employee

The Email Template object

List all email templates for a business

Create an email template

Create a new email template using AI

Copy a project email template into a specific business

Retrieve an email template

Preview an email template

Preview an email template as an image

Update an email template

Delete an email template

The Email Template Embed object

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

The Project Email Template object

List all project email templates

Retrieve a project email template

Preview a project email template

Preview a project email template as an image

The Business Email Address object

Retrieve the email addresses for a business

The Project Email Address object

List all project email addresses

The Draft Email object

Draft send an email based off an email template

Send an email based off an email template

The SMS Template object

List all SMS templates for a business

Create an SMS template

Retrieve an SMS template

Preview an SMS template

Preview an SMS template as an image

Update an SMS template

Delete an SMS template

The SMS Template Embed object

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

The Draft SMS Message object

Draft send an SMS message from an SMS template

Send an SMS based off an SMS template

The ProjectPhoneNumber object

List all project phone numbers

Retrieve a project phone number

The Campaign object

List all campaigns

Create a campaign

Retrieve a campaign

View a campaign interactively

Preview a campaign

Preview a campaign as an image

Update a campaign

Start a campaign

Stop a campaign

Delete a campaign

The Campaign Embed object

Create a campaign embed

Create a campaign embed to create a new campaign

Retrieve a campaign embed

Embed the campaign editor

The Trigger object

List triggers for a business

Create a trigger

Retrieve a trigger

Activate a trigger

Deactivate a trigger

Track an event occuring within a business

The Unsubscribe Embed object

Create an unsubscribe embed

Retrieve an unsubscribe embed

Embed the unsubscribe form

The Rewards Program object

List all rewards programs

Create a rewards program

Retrieve a rewards program

The Tier object

List all tiers

Create a tier

The Member object

List all members for a rewards program

Create a member

Retrieve a member

The Location object

List all locations

List the locations under a rewards program

Create a location

Retrieve a location

Update a location

The Location Member object

List all location members

Create a new location member

Retrieve a location member

Track when a user books a class

Track when a user purchases an item

Track when a user redeems their points

The Flow object

Create a flow

Embed a flow

Base

Email and SMS

Loyalty

Dashboard

Support

API Documentation

Businesses

Customers

Segments

Employees

The Segment object