Pocketflows home page

Dashboard
Support
Dashboard

Project Phone Numbers

The ProjectPhoneNumber object

Email Templates

The Email Template object
GET
List all email templates for a business
POST
Create an email template
POST
Create a new email template using AI
POST
Copy a project email template into a specific business
GET
Retrieve an email template
GET
Preview an email template
GET
Preview an email template as an image
POST
Update an email template
DEL
Delete an email template

Email Template Embeds

The Email Template Embed object
POST
Create an email template embed to edit an existing email template
POST
Create an email template embed to create a brand new email template
GET
Retrieve an email template embed
GET
Embed the email template editor

Project Email Templates

The Project Email Template object
GET
List all project email templates
GET
Retrieve a project email template
GET
Preview a project email template
GET
Preview a project email template as an image
POST
Copy a project email template into a specific business

Business Email Addresses

The Connected Email Address object
GET
Retrieve the email addresses for a business

Project Email Addresses

The Project Email Address object
GET
List all project email addresses

Emails

The Draft Email object
POST
Draft send an email based off an email template
POST
Send an email based off an email template

SMS Templates

The SMS Template object
GET
List all SMS templates for a business
POST
Create an SMS template
GET
Retrieve an SMS template
GET
Preview an SMS template
GET
Preview an SMS template as an image
POST
Update an SMS template
DEL
Delete an SMS template

SMS Template Embeds

The SMS Template Embed object
POST
Create an SMS template embed to edit an existing SMS template
POST
Create an SMS template embed to create a brand new SMS template
GET
Retrieve an SMS template embed
GET
Embed the SMS template editor

SMS Messages

The Draft SMS Message object
POST
Draft send an SMS message from an SMS template
POST
Send an SMS based off an SMS template

Project Phone Numbers

The ProjectPhoneNumber object
GET
List all project phone numbers
GET
Retrieve a project phone number

Campaigns

The Campaign object
GET
List all campaigns
POST
Create a campaign
GET
Retrieve a campaign
GET
View a campaign interactively
GET
Preview a campaign
GET
Preview a campaign as an image
POST
Update a campaign
POST
Start a campaign
POST
Stop a campaign
DEL
Delete a campaign

Campaign Embeds

The Campaign Embed object
POST
Create a campaign embed
POST
Create a campaign embed to create a new campaign
GET
Retrieve a campaign embed
GET
Embed the campaign editor

Triggers

The Trigger object
GET
List triggers for a business
POST
Create a trigger
GET
Retrieve a trigger
POST
Activate a trigger
POST
Deactivate a trigger
POST
Track an event occuring within a business

Unsubscribing from Campaigns

The Unsubscribe Embed object
POST
Unsubscribe a customer from campaigns and triggers
POST
Create an unsubscribe embed
GET
Retrieve an unsubscribe embed
GET
Embed the unsubscribe form

Project Phone Numbers

The ProjectPhoneNumber object

id

string

required

The ID of the phone number

phone_number

string

required

The phone number

Send an SMS based off an SMS template List all project phone numbers

Powered by Mintlify