Email Templates
- The Email Template object
- GETList all email templates for a business
- POSTCreate an email template
- POSTCreate a new email template using AI
- POSTCopy a project email template into a specific business
- GETRetrieve an email template
- GETPreview an email template
- GETPreview an email template as an image
- POSTUpdate an email template
- DELDelete an email template
Email Template Embeds
Project Email Templates
Business Email Addresses
Project Email Addresses
Emails
SMS Templates
SMS Template Embeds
SMS Messages
Business Phone Numbers
Project Phone Numbers
Campaigns
- The Campaign object
- The Campaign Execution object
- GETList all campaigns
- POSTCreate a campaign
- GETRetrieve a campaign
- GETView a campaign interactively
- GETPreview a campaign
- GETPreview a campaign as an image
- POSTUpdate a campaign
- POSTStart a campaign
- POSTStop a campaign
- DELDelete a campaign
- GETGet the executions of a campaign
Campaign Embeds
Triggers
List triggers for a business
curl --request GET \
--url https://api.pocketflows.com/businesses/{id}/triggers \
--header 'Authorization: Basic <encoded-value>'{
"triggers": [
{
"id": "<string>",
"name": "<string>",
"trigger": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"status": "draft",
"filter": "<string>",
"email_address": "<string>",
"phone_number": "<string>"
}
]
}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
An array of triggers
The ID of the trigger
The name of the trigger
The event that triggers the trigger
The steps of the trigger
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 status of the trigger. One of "draft", "active", or "inactive"
draft An additional filter that determines if the trigger should be run
The ID of the email address or project email address associated with the trigger. Will be used to send emails as part of this trigger
The ID of the phone number or project phone number associated with the trigger. Will be used to send SMS messages as part of this trigger
curl --request GET \
--url https://api.pocketflows.com/businesses/{id}/triggers \
--header 'Authorization: Basic <encoded-value>'{
"triggers": [
{
"id": "<string>",
"name": "<string>",
"trigger": "<string>",
"steps": [
{
"type": "email",
"custom_step_id": "<string>",
"email_template_id": "<string>"
}
],
"status": "draft",
"filter": "<string>",
"email_address": "<string>",
"phone_number": "<string>"
}
]
}