Guide
Growth Flows and Automation
Configure triggers, sequences, delays, eligibility, rewards, and queue visibility.
SoundSync
Template families
| Flow | Purpose |
|---|---|
| Cart recovery | Follow up on an eligible abandoned checkout |
| Review request | Invite feedback after the relevant customer event |
| Cross-sell / upsell | Recommend eligible related products |
| Product onboarding | Send product access/setup guidance |
| Promotion follow-up | Continue an eligible offer conversation |
| Winback | Reconnect with an eligible inactive audience |
| Product update | Explain a release and its change information |
| New product release | Announce a relevant launch |
| Special promotion | Prepare a selected campaign sequence |
SoundSync
Configure before activating
-
Select a trigger
Use the template's supported event, API event, or manual segment. A template existing does not mean every event source is firing.
-
Set the audience
Apply consent, suppression, product scope, ownership exclusions, and eligibility filters.
-
Design the sequence
Review each email, merge tag, delay, product link, and optional offer/reward.
-
Review timing
Use available quiet-hours, timezone, and smart-window controls. Do not assume a daily cap or cooldown is active merely because older documentation mentioned one.
-
Preview and test
Preview the selected sequence step and send its test only to the signed-in developer account. Sender and compliance-footer readiness still apply.
-
Inspect activity
Review queued, sent, failed, and delivery-unknown recipients and conversion records; pause or archive flows deliberately.
Manage the sequence without losing context
Create or duplicate a flow, review every step, activate or pause it, and use the supported manual run for its eligible audience. Reward messages and primary sequence messages are reported separately. Inspect step metrics, queue snapshot, and recipient history rather than assuming every scheduled item was delivered.
An unknown delivery outcome is not a confirmed failure. Check provider acceptance before resending. If no new audience members are eligible, running the flow does not create permission to contact suppressed or unsubscribed people.
Rewards need their own rules
Where supported, a flow can issue an eligible offer. Check scope, expiry, eligibility, stacking, and the paid-price floor. A review incentive must not depend on a positive rating or be represented as an independently verified purchase review.
An API-triggered flow must not accept arbitrary external recipients as permission to market. Trigger context and consent still apply.
SoundSync
Growth Flow configuration
Follow the recipient through the flow
Use the individual flow workspace to configure triggers, sequences, delays, quiet hours, eligibility, suppression, tests, queue activity, and reports. Supported families include cart, review, cross-sell/upsell, onboarding, promotion follow-up, Winback, updates, new releases, and special promotions.
Recipient rows show the relevant cart or recommended product when known. Use Check delivery to persist a provider-outcome review. Failed recipients can be retried when eligible; uncertain outcomes stay under review rather than being blindly resent. Serial-redemption events can feed supported flows, while historical backfill is reviewed rather than treated as a fresh automatic send.
One bundle purchase, one review invitation
A configured review flow can send one consolidated invitation for a bundle purchase. The customer chooses an eligible included product to review; SoundSync does not send a separate invitation for every member or create a new whole-bundle rating from those reviews.
A review reward is issued at most once per eligible invitation, after a qualifying sent invitation and approved product review. Creating a flow or submitting any review is not a guarantee of a reward.
Recover an unconfirmed send deliberately
Check delivery first. A confirmed provider acceptance marks the recipient sent without sending it again. A known failed, unsent recipient uses the ordinary retry action.
Retry unconfirmed is a separate guarded action. It requires a complete unconfirmed provider-history review at least 125 minutes after the recorded attempt, no provider message or transaction ID, no sent/opened/clicked activity, and an active flow. The request reviews the outcome again before requeueing; changed or incomplete evidence leaves it on hold.
Explicitly acknowledge the risk of a duplicate message. Provider history can be incomplete even when no matching event was found. Consent, suppression and queue eligibility are checked again before a queued retry sends.
Read Growth Flow reporting in the selected range
Choose a day window or All time. GET /api/developer/marketing/growth-flows/summary?range=all returns range:"all" and rangeDays:null. A bounded report returns range:"days" and an integer rangeDays; the default is 30 days. The list endpoint also accepts range=all. The ordinary flow list hides archived flows.
Archiving stops a flow from appearing in the ordinary list without erasing its history. Summary totals include archived activity; totalFlows includes that history, while activeFlows counts active entries. archivedFlows and archivedActivity identify the archived contribution. Do not expect summing only the visible flow cards to reproduce every historical total.
emailsSent, conversions and revenue use the selected reporting window. queuedNow, sentTotal, failedTotal and unresolvedTotal are current queue-lifecycle snapshots, with queueSnapshotAt showing when they were read. They are not alternative names for the ranged send count.
Cross-sell from actual access, not just paid checkout
Growth Flows can respond to supported access and entitlement events, including free claims, imported or manual grants, reseller fulfillment and subscription access as well as managed purchases. Access is not necessarily a sale: preserve the event source and financial context.
Cross-sell recommendations select eligible products the customer does not already own and can include separate product links through {{recommended_product_links}}. Ownership, current audience restrictions and suppressions are checked again before sending. Stable event/queue identity prevents replaying the same access event as a new campaign.
Use any or all product matching deliberately when selecting owners of a product set. Flow delay, cadence and frequency caps are developer configuration; a seven-day interval used by one workspace is not a platform-wide promise. Historical catch-up is an explicit reviewed operation, not automatic mail to every imported customer.
Bring eligible existing customers into a flow
Growth Flow eligibility counts and historical enrollment now use the same recipient rules. Preview the current count and blocking reason, then enroll all previous eligible recipients into an active flow when automation is enabled. Valid product access can come from supported sources other than a paid checkout; the selected audience and marketing restrictions still apply.
Historical enrollment schedules work with at least a 24-hour wait; it is not an immediate email send. Repeating the same pending configuration reuses that job. Changing the configuration can supersede the pending fanout, and eligibility is checked again before sending. Prior sends, pending work and suppressions prevent inappropriate repeat delivery.
Product onboarding needs its setup URL. Product updates and new-release flows need the release destination. Cart recovery, review requests, cross-sells, promo follow-up, winback and special promotions each retain their relevant product, audience and offer requirements. A larger count is not a delivery guarantee or access to another developer's contacts.
SoundSync
Review the historical audience before scheduling
The historical enrollment dialog explains eligible previous customers, the minimum wait and the configured sequence timing. This example does not enroll or email anyone.
Design the email customers will receive
The shared compact editor supports primary and reward emails, subject and body content, saved design and branded light/dark logos and palette. Preview uses the maintained delivery renderer, including link and background handling. Different mail clients can still render differently.
Previewing does not send, enroll contacts, change consent or consume a message allowance. Review the destination URLs, reward, sender identity and suppression-aware audience before enabling the flow. Purchases and storefront signups remain automatically enrolled in the relevant marketing list; no separate opt-in checkbox is added.
SoundSync
A real branded campaign
This rendered preview comes from an existing Moonwave FX campaign, with its product artwork, offer, call to action and branded footer. Personal contact details are blurred. It shows campaign design, not an inbox-delivery guarantee or current SoundSync platform pricing.
SoundSync
History enrollment and email preview
/api/developer/marketing/growth-flows/{flowId}/history-preview
Preview all previous eligible recipients without enrolling them
- Auth
- Account Bearer session token
- Scope
- marketing.manage and all-products workspace scope. Current audience eligibility and suppression are rechecked.
- Returns
- HTTP 200: flowId, name, type, status, eligibleRecipients, reason, minimumWaitHours, scope, canEnroll.
- Notes
- A count is a current eligibility estimate, not a delivery promise. It shares the enrollment query and reflects current product access, audience, flow configuration, prior work and marketing restrictions. flowId may be a decimal string. canEnroll is not proof that the master automation setting is enabled.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flowId": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
],
"description": "Database workflow identifier; accept its decimal string form without treating it as a UUID."
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"eligibleRecipients": {
"type": "integer",
"minimum": 0
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"minimumWaitHours": {
"const": 24
},
"scope": {
"const": "all_previous"
},
"canEnroll": {
"type": "boolean",
"description": "Hint from active workflow, configuration and eligible count. Enrollment separately requires automation to be enabled and rechecks eligibility."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/marketing/growth-flows/{flowId}/enroll-previous
Schedule historical eligible customers for an active growth flow
- Auth
- Account Bearer session token
- Scope
- marketing.manage and all-products workspace scope. Current audience eligibility and suppression are rechecked.
- Request fields
- scope: "all_previous" (required)
- Returns
- HTTP 200: review the response schema below.
- Notes
- Requires an active flow and enabled automation. A new job returns started:true, jobId and eligibleRecipients. The same pending configuration returns started:false, alreadyRunning:true and the existing jobId, without a fresh eligible count. Changed pending configuration can supersede earlier fanout. No eligible recipients returns started:false, eligibleRecipients:0 and no jobId. Messages wait at least 24 hours; recipient eligibility is checked again before sending. This is a queue mutation, not an immediate-send or harmless preview.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"scope": {
"const": "all_previous"
}
},
"additionalProperties": true,
"required": [
"scope"
]
}
HTTP 200 response (application/json)
{
"oneOf": [
{
"type": "object",
"properties": {
"started": {
"const": true
},
"jobId": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
]
},
"eligibleRecipients": {
"type": "integer",
"minimum": 1
},
"minimumWaitHours": {
"const": 24
}
},
"additionalProperties": true,
"required": [
"started",
"jobId",
"eligibleRecipients",
"minimumWaitHours"
]
},
{
"type": "object",
"properties": {
"started": {
"const": false
},
"alreadyRunning": {
"const": true
},
"jobId": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
]
},
"minimumWaitHours": {
"const": 24
}
},
"additionalProperties": true,
"required": [
"started",
"alreadyRunning",
"jobId",
"minimumWaitHours"
]
},
{
"type": "object",
"properties": {
"started": {
"const": false
},
"eligibleRecipients": {
"const": 0
},
"minimumWaitHours": {
"const": 24
}
},
"additionalProperties": true,
"required": [
"started",
"eligibleRecipients",
"minimumWaitHours"
]
}
]
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/marketing/growth-flows/email-preview
Render a branded primary or reward email without sending
- Auth
- Account Bearer session token
- Scope
- marketing.manage and all-products workspace scope. Current audience eligibility and suppression are rechecked.
- Request fields
- type: string
- productId: integer
- reward: boolean
- email: object
- metadata: object
- Returns
- HTTP 200: subject, html, text.
- Notes
- Uses the maintained delivery renderer and current branding. headerEnabled:false removes the header; headerLogo accepts a supported HTTP(S) URL or an empty value. Cross-sell trigger products and recommendations are separate. Preview is not an email send, inbox-rendering guarantee, consent change or recipient enrollment.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"productId": {
"type": "integer",
"minimum": 1
},
"reward": {
"type": "boolean"
},
"email": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"body": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"emailDesign": {
"type": "object",
"properties": {
"headerEnabled": {
"type": "boolean"
},
"headerLogo": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"properties": {
"triggerProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"recommendedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"html": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/history-preview
Preview all previous eligible recipients without enrolling them
- Auth
- Account Bearer session token
- Scope
- marketing.manage and all-products workspace scope. Current audience eligibility and suppression are rechecked.
- Returns
- HTTP 200: flowId, name, type, status, eligibleRecipients, reason, minimumWaitHours, scope, canEnroll.
- Notes
- A count is a current eligibility estimate, not a delivery promise. It shares the enrollment query and reflects current product access, audience, flow configuration, prior work and marketing restrictions. flowId may be a decimal string. canEnroll is not proof that the master automation setting is enabled.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flowId": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
],
"description": "Database workflow identifier; accept its decimal string form without treating it as a UUID."
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"eligibleRecipients": {
"type": "integer",
"minimum": 0
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"minimumWaitHours": {
"const": 24
},
"scope": {
"const": "all_previous"
},
"canEnroll": {
"type": "boolean",
"description": "Hint from active workflow, configuration and eligible count. Enrollment separately requires automation to be enabled and rechecks eligibility."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/enroll-previous
Schedule historical eligible customers for an active growth flow
- Auth
- Account Bearer session token
- Scope
- marketing.manage and all-products workspace scope. Current audience eligibility and suppression are rechecked.
- Request fields
- scope: "all_previous" (required)
- Returns
- HTTP 200: review the response schema below.
- Notes
- Requires an active flow and enabled automation. A new job returns started:true, jobId and eligibleRecipients. The same pending configuration returns started:false, alreadyRunning:true and the existing jobId, without a fresh eligible count. Changed pending configuration can supersede earlier fanout. No eligible recipients returns started:false, eligibleRecipients:0 and no jobId. Messages wait at least 24 hours; recipient eligibility is checked again before sending. This is a queue mutation, not an immediate-send or harmless preview.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"scope": {
"const": "all_previous"
}
},
"additionalProperties": true,
"required": [
"scope"
]
}
HTTP 200 response (application/json)
{
"oneOf": [
{
"type": "object",
"properties": {
"started": {
"const": true
},
"jobId": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
]
},
"eligibleRecipients": {
"type": "integer",
"minimum": 1
},
"minimumWaitHours": {
"const": 24
}
},
"additionalProperties": true,
"required": [
"started",
"jobId",
"eligibleRecipients",
"minimumWaitHours"
]
},
{
"type": "object",
"properties": {
"started": {
"const": false
},
"alreadyRunning": {
"const": true
},
"jobId": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
]
},
"minimumWaitHours": {
"const": 24
}
},
"additionalProperties": true,
"required": [
"started",
"alreadyRunning",
"jobId",
"minimumWaitHours"
]
},
{
"type": "object",
"properties": {
"started": {
"const": false
},
"eligibleRecipients": {
"const": 0
},
"minimumWaitHours": {
"const": 24
}
},
"additionalProperties": true,
"required": [
"started",
"eligibleRecipients",
"minimumWaitHours"
]
}
]
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/email-marketing/growth-flows/email-preview
Render a branded primary or reward email without sending
- Auth
- Account Bearer session token
- Scope
- marketing.manage and all-products workspace scope. Current audience eligibility and suppression are rechecked.
- Request fields
- type: string
- productId: integer
- reward: boolean
- email: object
- metadata: object
- Returns
- HTTP 200: subject, html, text.
- Notes
- Uses the maintained delivery renderer and current branding. headerEnabled:false removes the header; headerLogo accepts a supported HTTP(S) URL or an empty value. Cross-sell trigger products and recommendations are separate. Preview is not an email send, inbox-rendering guarantee, consent change or recipient enrollment.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"productId": {
"type": "integer",
"minimum": 1
},
"reward": {
"type": "boolean"
},
"email": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"body": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"emailDesign": {
"type": "object",
"properties": {
"headerEnabled": {
"type": "boolean"
},
"headerLogo": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"properties": {
"triggerProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"recommendedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"html": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
Configure multi-product cross-sell entry
Select the products that should trigger entry, then choose the separate recommendation set. The flow keeps one sequence for a qualifying paid order even when that order contains several selected products. Later qualifying orders can enroll the customer again; historical enrollment has its own duplicate and eligibility checks.
Use {{trigger_products}} to name the selected trigger products that the customer owns. The trigger selection is not the list of products to recommend. Previously owned recommendations and suppressed contacts remain ineligible.
Edit or remove the email header
The shared email editor lets you change the logo header or remove it from a campaign, primary flow email or reward email. The saved design is used by preview, test and delivery rendering. Keep the required unsubscribe and sender information in the footer; removing the header is not permission to remove those details.
Connect a purchase reward to the cross-sell flow
Choose Purchase reward, select a current program or create one from the flow, then save its trigger products separately from the recommended products. Saving can add those trigger products to the program's qualifying products without replacing its existing products or coupon policy. Review that shared program before reusing it in another flow.
Paid-only rewards require a qualifying order belonging to the recipient, with remaining paid value. To include eligible free access, explicitly enable Include free product acquisitions and use a program that allows free items. The flow then checks the active recipient-owned entitlement; a popup claim must be verified. Expired, revoked, unverified or fully refunded access does not qualify. A single free grant cannot satisfy a reward requiring multiple items.
A free-access reward records its source entitlement rather than inventing a purchase. Repeating the same acquisition for the same reward program reuses the coupon, including across flows using that program. Paid-order rewards keep their original order identity. Historical enrollment remains an explicit eligibility-reviewed operation, not permission to resend every past contact.
Use {{promo_code}} for the primary reward code and {{reward_codes}} when the issued reward contains several codes. A preview uses example reward text and does not grant a coupon. A paused, deleted or out-of-date program cannot issue a new reward; previously issued coupons keep their own rules.
A billing pause does not restart the sequence
A queued Growth Flow email can show Sending paused while billing or a chosen spending limit needs attention. The planned Scheduled for date stays separate from Automatic retry. A past planned date is not proof that an email was sent, and updating billing does not enroll the customer again or restart the flow delay.
The recipient API returns scheduledFor, sendHoldCode, failureReason and nextRetryAt. The retry deadline is normally set 15 minutes after a deferred funding attempt; it is the earliest retry eligibility, not a promised delivery time. Once funding and spend checks succeed, the worker can retry eligible work automatically. The flow must remain active, and current audience, ownership, suppression and provider checks still apply.
Do not duplicate the flow or use Retry unconfirmed to release a normal funding hold. delivery_unknown means the provider outcome is uncertain and follows its separate review and duplicate-risk rules. An accepted send is counted once; a queued billing hold is not an accepted send.
SoundSync
Planned date, retry and delivery are different
| Value | Meaning |
|---|---|
| Scheduled for / scheduledFor | The planned date, preserved through a funding pause; not a newly enrolled delay |
| sendHoldCode and failureReason | Why sending is paused; inspect billing or the chosen spending limit |
| Automatic retry / nextRetryAt | The next retry eligibility, not a promised provider acceptance or inbox arrival |
| sentAt | A recorded send outcome; a queued date alone does not establish delivery |
Choose whether free product access can enter
Include free product acquisitions is a developer flow setting, not a customer marketing-permission control. Supported cross-sell, review-request, onboarding and product-update flows can use eligible verified free claims, zero-dollar checkouts and other active product grants. Turning it off requires qualifying paid-acquisition evidence; older flows retain their existing behavior until saved deliberately.
Purchase-reward flows remain paid-only unless free acquisitions are explicitly enabled and the reward program permits them. Popup verification and saved newsletter choices stay protected. Recipient ownership, access state, expiry, refunds and suppressions are checked before enrollment or reward issuance. Creating a coupon does not itself redeem another product or create sale/payout revenue.
SoundSync
Eligibility is not the email trigger
| Flow | What starts the sequence |
|---|---|
| Cross-sell and upsell | A qualifying purchase or product-access event must match the selected trigger products. Free access also needs the saved acquisition setting and any reward-program requirements. |
| Review request and product onboarding | Configured purchase/access events start the sequence with its delay, review and duplicate protections. Access events require an explicitly saved acquisition setting; a missing legacy setting is not permission to replay old grants. |
| Product update | Eligible free access can qualify a recipient for the audience. Acquiring access alone does not start a product-update email: use the product-update/release trigger or deliberately reviewed historical enrollment. |
| Existing customers | Preview history first, then explicitly enroll the reviewed eligible audience. Saving the free-acquisition setting alone does not replay history or send messages. |
SoundSync
