Guide

Growth Flow and Automation API

Flow lifecycle, sequence previews, developer-only tests, queue activity, suppression rules, and trigger signals.

Start with getting started Explore API docs

SoundSync

Growth and automation operations

Current route and service contracts. Examples below are illustrative; live provider outcomes and client-host testing are separate checks.

GET /api/developer/marketing/growth-flows

List flows and their activity.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/growth-flows/summary

Read aggregate flow metrics and queue status.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/growth-flows/templates

List supported template definitions.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/growth-flows/promo-options

Read eligible promotion/reward choices.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/growth-flows

Create a flow for a supported template and audience.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/growth-flows/:flowId

Read the sequence and step/reward context.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: flowId path
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/growth-flows/:flowId/recipients

Read recipient outcomes with filters and pagination.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: flowId path
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

PATCH /api/developer/marketing/growth-flows/:flowId

Update flow configuration.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: flowId path
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/growth-flows/:flowId/activate

Activate the configured flow.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: flowId path
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/growth-flows/:flowId/pause

Pause future flow work.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: flowId path
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/growth-flows/:flowId/duplicate

Copy a flow for review.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: flowId path
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/growth-flows/:flowId/archive

Archive the selected flow.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: flowId path
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/growth-flows/:flowId/run

Launch supported manual work for the eligible audience.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: flowId path
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/growth-flows/:flowId/preview

Preview rendered sequence content.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: flowId path
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/growth-flows/:flowId/test-email

Send a selected test step to the signed-in developer.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: flowId
Optional email/to: must match signed-in developer
Optional emailNumber: valid step number
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/growth-flows/templates/:type/activate

Activate a supported template workflow.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/growth-flows/templates/:type/pause

Pause the corresponding template workflow.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/automation/settings

Read automation enablement and settings.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

PATCH /api/developer/marketing/automation/settings

Update automation readiness/settings.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/automation/workflows

List automation workflows.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/automation/workflows

Create an automation workflow.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

PATCH /api/developer/marketing/automation/workflows/:workflowId

Update the workflow.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: workflowId path
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/automation/suppression-rules

Read suppression rules.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/automation/workflows/:workflowId/suppression-rules

Create a workflow suppression rule.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: workflowId path
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/automation/queue

Read queued work and outcomes.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/automation/audit-events

Read automation activity history.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

GET /api/developer/marketing/automation/signals

Read trigger signal activity.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Supported query filters/pagination where applicable
Returns: Scoped current records or rendered preview.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/automation/signals/test

Create a controlled test signal.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

POST /api/developer/marketing/automation/process

Request bounded processing under the supported permission boundary.

Auth: Developer Bearer JWT with applicable marketing permission and workspace scope.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: Relevant flow/template identifier where required
Operation-specific configuration; use the matching flow or automation guide
Returns: Operation result; provider delivery and accounting must be checked separately.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access.

SoundSync

Illustrative flow test

curl -X POST "https://www.soundsync.dev/api/developer/marketing/growth-flows/123/test-email" \
  -H "Authorization: Bearer DEVELOPER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"emailNumber":1}'

Respect consent at delivery time

An event or manual launch does not turn a transactional-only customer into a marketing subscriber. Consent, suppression, product eligibility, sender readiness, and the compliance footer apply before sending. Growth-flow tests render a selected step to the signed-in developer only and are not a bulk audience send.

Read outcomes before retrying

Queue and recipient views distinguish queued, sent, failed, and delivery_unknown work. A delivery_unknown outcome means provider acceptance has not been established, not that nothing was sent. An interrupted worker can leave an unknown provider outcome; verify acceptance before retrying. Provider-accepted marketing sends share the 1,000-email monthly allowance and started-block overage model. Preview and test results are not campaign conversion statistics.