Guide
Growth Flow and Automation API
Flow lifecycle, sequence previews, developer-only tests, queue activity, suppression rules, and trigger signals.
SoundSync
Growth and automation operations
Current route and service contracts. Examples below are illustrative; live provider outcomes and client-host testing are separate checks.
/api/developer/marketing/growth-flows
List flows and their activity.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- query days: integer
- query range: string. Use all for all-time metrics; otherwise days defaults to 30.
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
Query and header parameters
[
{
"name": "days",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 3650
},
"required": false,
"description": ""
},
{
"name": "range",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "Use all for all-time metrics; otherwise days defaults to 30."
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"queueSnapshotAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/summary
Read aggregate flow metrics and queue status.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- query days: integer
- query range: string. Use all for all time; a day range such as 90d selects that window when days is omitted.
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Default 30 days. Archived flows are hidden from flows but retained in totalFlows, archivedFlows, archivedActivity and aggregate history. Queue totals are a current snapshot at queueSnapshotAt, not a date-range delivery count. Revenue is attributed net product revenue after discounts and product refunds/disputes, excluding tax; it is not developer payout earnings. Internal boolean service options are not HTTP query switches.
Request, response and error reference
Query and header parameters
[
{
"name": "days",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 3650
},
"required": false,
"description": ""
},
{
"name": "range",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "Use all for all time; a day range such as 90d selects that window when days is omitted."
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"rangeDays": {
"type": [
"integer",
"null"
],
"description": "Null for range=all; otherwise the effective day count."
},
"range": {
"type": "string",
"enum": [
"all",
"days"
]
},
"activeFlows": {
"type": "integer"
},
"archivedFlows": {
"type": "integer"
},
"archivedActivity": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"emailsSent": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
}
},
"totalFlows": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"revenue": {
"type": "number"
},
"conversions": {
"type": "integer"
},
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"queueSnapshotAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"recommendations": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/templates
List supported template definitions.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/promo-options
Read eligible promotion/reward choices.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- query search: string
- query selectedId: integer
- query selectedRewardId: integer
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Returns static promo codes separately from purchase-reward programs. A selected inactive reward may be included for editing; it is not eligible for new reward issuance.
Request, response and error reference
Query and header parameters
[
{
"name": "search",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "selectedId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "selectedRewardId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"promoCodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"code": {
"type": "string"
},
"discountType": {
"type": "string"
},
"discountValue": {
"type": "number"
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"purchaseRewards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"title": {
"type": "string"
},
"discountType": {
"type": "string"
},
"discountValue": {
"type": "number"
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows
Create a flow for a supported template and audience.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- name: string
- status: draft | active | paused | archived
- triggerType: string
- segmentId: integer
- campaignId: integer
- delayMinutes: integer
- quietHoursStrategy: defer | skip | ignore
- smartTimingEnabled: boolean
- suppressionPolicy: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- messageTemplate: object
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- type: string (required)
- description: string
- audienceId: integer
- productId: integer
- includeFreeAcquisitions: boolean. For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program.
- relatedProductIds: array
- promotionId: integer
- inactiveDays: integer
- setupUrl: string
- releaseUrl: string
- version: string
- downloadUrl: string
- recommendedProductUrl: string
- incentive: object
- sequence: array
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Create a flow for a supported template and audience. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. includeFreeAcquisitions must be a JSON boolean at top level or in metadata; a supplied top-level boolean takes precedence. Supported access flows include cross_sell_upsell, review_request, product_onboarding and product_update. Cross-sell and configured review/onboarding flows can respond to qualifying access events. Product-update audience eligibility does not make a grant a release trigger: a product-update event or deliberately reviewed history enrollment is still required. Saving the setting alone does not replay history or send messages. Explicit false retains paid-acquisition proof. A purchase-reward flow needs explicit true plus a program permitting free items; a conflicting program is rejected. Active recipient-owned access, popup verification, current state/expiry, enrollment eligibility and suppression checks remain required. Free access and reward coupons do not become paid orders. Retry of the same acquisition/program reuses its reward.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true,
"required": [
"type"
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
Operation errors: GROWTH_FLOW_ACQUISITION_SETTING_INVALID, GROWTH_FLOW_REWARD_FREE_ACCESS_EXCLUDED.
/api/developer/marketing/growth-flows/:flowId
Read the sequence and step/reward context.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/:flowId/recipients
Read recipient outcomes with filters and pagination.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- query page: integer
- query limit: integer
- query search: string
- query status: string
- query emailNumber: integer
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. For status=queued, inspect sendHoldCode, failureReason and nextRetryAt separately from scheduledFor. A funding hold keeps the planned date and uses a separate retry deadline, normally set 15 minutes after the deferred attempt. Worker selection and claim both respect that deadline. Once funding and spend checks succeed, held work can retry automatically; provider availability, active flow, consent, ownership and queue eligibility still apply. Do not reset the flow or use Retry unconfirmed for an ordinary funding pause. The row may remain queued while sending is paused; a past scheduledFor is not proof of a send.
Request, response and error reference
Query and header parameters
[
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "search",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "status",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "emailNumber",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"recipients": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"workflowId": {
"type": "integer",
"minimum": 1
},
"email": {
"type": "string",
"format": "email"
},
"name": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"status": {
"type": "string"
},
"failureReason": {
"type": [
"string",
"null"
]
},
"scheduledFor": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Planned send date. For a queued funding hold, preserves not_before when recorded, otherwise scheduled_for; not the next funding-retry time."
},
"sendHoldCode": {
"type": [
"string",
"null"
],
"description": "Queued spend/funding hold code, otherwise null. A hold is not provider acceptance or delivery_unknown."
},
"nextRetryAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Queued funding retry eligibility from spendHoldRetryAt, with a legacy scheduled_for fallback. Otherwise null. Not a guaranteed send time."
},
"sentAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"sendAttemptAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"deliveryReviewedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"deliveryReviewOutcome": {
"type": [
"string",
"null"
]
},
"deliveryReviewComplete": {
"type": "boolean"
},
"deliveryReviewEventsScanned": {
"type": "integer"
},
"retryUnconfirmedAllowed": {
"type": "boolean"
},
"productName": {
"type": "string"
},
"productRole": {
"type": "string"
}
},
"additionalProperties": true
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"total": {
"type": "integer"
},
"totalPages": {
"type": "integer"
}
},
"additionalProperties": true
},
"search": {
"type": "string"
},
"status": {
"type": "string"
},
"emailNumber": {
"type": [
"integer",
"null"
]
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/:flowId
Update flow configuration.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- name: string
- status: draft | active | paused | archived
- triggerType: string
- segmentId: integer
- campaignId: integer
- delayMinutes: integer
- quietHoursStrategy: defer | skip | ignore
- smartTimingEnabled: boolean
- suppressionPolicy: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- messageTemplate: object
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- type: string
- description: string
- audienceId: integer
- productId: integer
- includeFreeAcquisitions: boolean. For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program.
- relatedProductIds: array
- promotionId: integer
- inactiveDays: integer
- setupUrl: string
- releaseUrl: string
- version: string
- downloadUrl: string
- recommendedProductUrl: string
- incentive: object
- sequence: array
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Update flow configuration. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. includeFreeAcquisitions must be a JSON boolean at top level or in metadata; a supplied top-level boolean takes precedence. Supported access flows include cross_sell_upsell, review_request, product_onboarding and product_update. Cross-sell and configured review/onboarding flows can respond to qualifying access events. Product-update audience eligibility does not make a grant a release trigger: a product-update event or deliberately reviewed history enrollment is still required. Saving the setting alone does not replay history or send messages. Explicit false retains paid-acquisition proof. A purchase-reward flow needs explicit true plus a program permitting free items; a conflicting program is rejected. Active recipient-owned access, popup verification, current state/expiry, enrollment eligibility and suppression checks remain required. Free access and reward coupons do not become paid orders. Retry of the same acquisition/program reuses its reward.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
Operation errors: GROWTH_FLOW_ACQUISITION_SETTING_INVALID, GROWTH_FLOW_REWARD_FREE_ACCESS_EXCLUDED.
/api/developer/marketing/growth-flows/:flowId/activate
Activate the configured flow.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Activate the configured flow. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/:flowId/pause
Pause future flow work.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Pause future flow work. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/:flowId/duplicate
Copy a flow for review.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Copy a flow for review. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/:flowId/archive
Archive the selected flow.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Archive the selected flow. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/:flowId/run
Launch supported manual work for the eligible audience.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Launch supported manual work for the eligible audience. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Launches supported manual audience work. No eligible audience means no permission to send to suppressed contacts.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
},
"signal": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"launched": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/:flowId/preview
Preview rendered sequence content.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/:flowId/test-email
Send a selected test step to the signed-in developer.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- emailNumber: integer
- email: string
- to: string
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Send a selected test step to the signed-in developer. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. The recipient must be the signed-in developer. Select a valid sequence step; sender/footer readiness still applies.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"emailNumber": {
"type": "integer",
"minimum": 1
},
"email": {
"type": "string",
"format": "email"
},
"to": {
"type": "string",
"format": "email"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"sent": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/templates/:type/activate
Activate a supported template workflow.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Activate a supported template workflow. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
},
"created": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/templates/:type/pause
Pause the corresponding template workflow.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Pause the corresponding template workflow. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
},
"created": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/settings
Read automation enablement and settings.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"automation_enabled": {
"type": "boolean"
},
"quiet_hours_enabled": {
"type": "boolean"
},
"quiet_hours_start": {
"type": "string"
},
"quiet_hours_end": {
"type": "string"
},
"timezone": {
"type": "string"
},
"smart_send_window_enabled": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/settings
Update automation readiness/settings.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- automationEnabled: boolean
- quietHoursEnabled: boolean
- quietHoursStart: string
- quietHoursEnd: string
- timezone: string
- smartSendWindowEnabled: boolean
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Update automation readiness/settings. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"automationEnabled": {
"type": "boolean"
},
"quietHoursEnabled": {
"type": "boolean"
},
"quietHoursStart": {
"type": "string"
},
"quietHoursEnd": {
"type": "string"
},
"timezone": {
"type": "string"
},
"smartSendWindowEnabled": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"automation_enabled": {
"type": "boolean"
},
"quiet_hours_enabled": {
"type": "boolean"
},
"quiet_hours_start": {
"type": "string"
},
"quiet_hours_end": {
"type": "string"
},
"timezone": {
"type": "string"
},
"smart_send_window_enabled": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/workflows
List automation workflows.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- query status: string
- query triggerType: string
- query limit: integer
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
Query and header parameters
[
{
"name": "status",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "triggerType",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"workflows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"trigger_type": {
"type": "string"
},
"segment_id": {
"type": "integer",
"minimum": 1
},
"campaign_id": {
"type": "integer",
"minimum": 1
},
"delay_minutes": {
"type": "integer"
},
"quiet_hours_strategy": {
"type": "string"
},
"smart_timing_enabled": {
"type": "boolean"
},
"suppression_policy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"message_template": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/workflows
Create an automation workflow.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- name: string (required)
- status: draft | active | paused | archived
- triggerType: string (required)
- segmentId: integer
- campaignId: integer
- delayMinutes: integer
- quietHoursStrategy: defer | skip | ignore
- smartTimingEnabled: boolean
- suppressionPolicy: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- messageTemplate: object
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Create an automation workflow. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true,
"required": [
"name",
"triggerType"
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"trigger_type": {
"type": "string"
},
"segment_id": {
"type": "integer",
"minimum": 1
},
"campaign_id": {
"type": "integer",
"minimum": 1
},
"delay_minutes": {
"type": "integer"
},
"quiet_hours_strategy": {
"type": "string"
},
"smart_timing_enabled": {
"type": "boolean"
},
"suppression_policy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"message_template": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/workflows/:workflowId
Update the workflow.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- name: string
- status: draft | active | paused | archived
- triggerType: string
- segmentId: integer
- campaignId: integer
- delayMinutes: integer
- quietHoursStrategy: defer | skip | ignore
- smartTimingEnabled: boolean
- suppressionPolicy: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- messageTemplate: object
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Update the workflow. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"trigger_type": {
"type": "string"
},
"segment_id": {
"type": "integer",
"minimum": 1
},
"campaign_id": {
"type": "integer",
"minimum": 1
},
"delay_minutes": {
"type": "integer"
},
"quiet_hours_strategy": {
"type": "string"
},
"smart_timing_enabled": {
"type": "boolean"
},
"suppression_policy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"message_template": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/suppression-rules
Read suppression rules.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- query workflowId: integer
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
Query and header parameters
[
{
"name": "workflowId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"workflow_id": {
"type": "integer",
"minimum": 1
},
"rule_type": {
"type": "string"
},
"product_id": {
"type": "integer",
"minimum": 1
},
"segment_id": {
"type": "integer",
"minimum": 1
},
"cooldown_hours": {
"type": "integer"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/workflows/:workflowId/suppression-rules
Create a workflow suppression rule.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- ruleType: string (required)
- productId: integer
- segmentId: integer
- cooldownHours: integer
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Create a workflow suppression rule. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"ruleType": {
"type": "string"
},
"productId": {
"type": "integer",
"minimum": 1
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"cooldownHours": {
"type": "integer"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"required": [
"ruleType"
],
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"rule": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/queue
Read queued work and outcomes.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- query status: string
- query workflowId: integer
- query limit: integer
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
Query and header parameters
[
{
"name": "status",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "workflowId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"queue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"workflow_id": {
"type": "integer",
"minimum": 1
},
"email": {
"type": "string",
"format": "email"
},
"status": {
"type": "string"
},
"scheduled_for": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"sent_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"failure_reason": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/audit-events
Read automation activity history.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- query workflowId: integer
- query limit: integer
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
Query and header parameters
[
{
"name": "workflowId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"auditEvents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"workflow_id": {
"type": "integer",
"minimum": 1
},
"event_type": {
"type": "string"
},
"message": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/signals
Read trigger signal activity.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- query signalType: string
- query limit: integer
- Returns
- Scoped current records or rendered preview.
- Side effects
- Retrieves the authorized resource. Operation-specific notes identify preparation or referral recording where applicable.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Requires marketing.manage and all-products scope, except template listing requires marketing view. Provider acceptance is not proof of inbox delivery.
Request, response and error reference
Query and header parameters
[
{
"name": "signalType",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"signals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"signal_type": {
"type": "string"
},
"product_id": {
"type": "integer",
"minimum": 1
},
"occurred_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"windows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/signals/test
Create a controlled test signal.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- signalType: string (required)
- customerId: integer
- developerCustomerId: integer
- productId: integer
- entitlementId: integer
- serialId: integer
- email: string
- source: string
- sourceId: string
- signalCount: integer
- occurredAt: string,null
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Create a controlled test signal. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. This is not a dry-run endpoint: a signal can queue eligible workflow work. Current permission, consent and suppression rules still apply.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"signalType": {
"type": "string"
},
"customerId": {
"type": "integer",
"minimum": 1
},
"developerCustomerId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"entitlementId": {
"type": "integer",
"minimum": 1
},
"serialId": {
"type": "integer",
"minimum": 1
},
"email": {
"type": "string",
"format": "email"
},
"source": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"signalCount": {
"type": "integer"
},
"occurredAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"required": [
"signalType"
],
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"signal": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"queued": {
"type": "integer"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/automation/process
Request bounded processing under the supported permission boundary.
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- limit: integer
- Returns
- Operation result; provider delivery and accounting must be checked separately.
- Side effects
- Request bounded processing under the supported permission boundary. Review the confirmation and retry requirements before repeating the request.
- Notes
- Automation and most growth-flow routes require marketing.manage and all-products scope. Template listing requires authenticated marketing view access. Processes real eligible queued work for the workspace. Do not use as a health check.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"processed": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"deliveryUnknown": {
"type": "integer"
},
"usageReconciled": {
"type": "integer"
},
"sent": {
"type": "integer"
},
"skipped": {
"type": "integer"
},
"failed": {
"type": "integer"
},
"deferred": {
"type": "integer"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
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.
SoundSync
Recipient recovery
Developer marketing automation permissions apply; do not blindly retry an uncertain delivery.
/api/developer/marketing/growth-flows/:flowId/recipients/:queueId/review
Check and persist an uncertain delivery outcome
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Review result for the workspace-owned flow recipient.
- Notes
- Persists a provider-history review. A matching acceptance marks sent without resending. Incomplete, ambiguous or unavailable history stays on hold.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"checkedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"outcome": {
"type": "string"
},
"eventsScanned": {
"type": "integer"
},
"retryEligible": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/marketing/growth-flows/:flowId/recipients/:queueId/retry
Retry an eligible failed recipient
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Returns
- Updated retry outcome after current consent and suppression checks.
- Notes
- Only a confirmed failed, unsent recipient is eligible. Requires an active flow and no recorded delivery. Sending rechecks consent, suppression and queue rules.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"checkedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"outcome": {
"type": "string"
},
"eventsScanned": {
"type": "integer"
},
"retryEligible": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
SoundSync
Guarded unconfirmed-send recovery
/api/developer/marketing/growth-flows/:flowId/recipients/:queueId/retry-unconfirmed
Recheck and requeue an eligible unconfirmed recipient
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- acknowledgeDuplicateRisk: true (required)
- Returns
- HTTP 200: status, message, checkedAt, outcome, eventsScanned, retryEligible.
- Notes
- Rechecks provider history before requeueing. Requires delivery_unknown, a complete unconfirmed review at least 125 minutes after the recorded attempt, no provider message/transaction IDs, no sent/opened/clicked event, and an active flow. A duplicate remains possible. Concurrent review/state changes reject the retry.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"acknowledgeDuplicateRisk": {
"const": true
}
},
"required": [
"acknowledgeDuplicateRisk"
],
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"checkedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"outcome": {
"type": "string"
},
"eventsScanned": {
"type": "integer"
},
"retryEligible": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: GROWTH_FLOW_DUPLICATE_RISK_ACK_REQUIRED, GROWTH_FLOW_UNCONFIRMED_RETRY_NOT_ALLOWED, GROWTH_FLOW_REVIEW_CHANGED, GROWTH_FLOW_INACTIVE, GROWTH_FLOW_DELIVERY_RECORDED, GROWTH_FLOW_RECIPIENT_NOT_FOUND.
SoundSync
Illustrative guarded retry request
curl --fail-with-body -sS -X POST "$SOUNDSYNC_API_BASE/api/developer/marketing/growth-flows/$FLOW_ID/recipients/$QUEUE_ID/retry-unconfirmed" \
-H "Authorization: Bearer $DEVELOPER_TOKEN" \
-H "Content-Type: application/json" \
--data '{"acknowledgeDuplicateRisk":true}'
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.
Attributed sales are not payout earnings
Marketing revenue uses attributable net product revenue from the canonical sale records: product subtotal less discounts, product refunds, chargebacks and dispute adjustments, excluding tax. Keep live and test scope aligned. Imported, administrative and migration-only rows are not funded managed-sale revenue. Provider event amounts are not the financial source of truth.
Direct campaign or flow attribution and supported click-to-purchase attribution are different evidence paths; the click path uses a fourteen-day window. This associates a recorded sale with marketing activity, not proof the message caused it. Counts are deduplicated at the reporting level; flow, campaign and whole-workspace totals are not automatically additive.
Campaign recipient reports use actual recipient rows once sending is finalized rather than an earlier audience estimate. Queue/provider reconciliation avoids treating one send as separate queued and sent messages. Acceptance is not proof of inbox delivery, and privacy features can affect observed opens and clicks.
SoundSync
Read an all-time summary
curl --fail-with-body -sS "$SOUNDSYNC_API_BASE/api/developer/marketing/growth-flows/summary?range=all" \
-H "Authorization: Bearer $DEVELOPER_TOKEN"
{
"range": "all",
"rangeDays": null,
"activeFlows": 1,
"totalFlows": 2,
"archivedFlows": 1,
"archivedActivity": [
{
"id": 7,
"name": "Previous release",
"emailsSent": 20,
"conversions": 1,
"revenue": 44.1
}
],
"emailsSent": 32,
"conversions": 2,
"revenue": 88.2,
"queuedNow": 3,
"sentTotal": 32,
"failedTotal": 0,
"unresolvedTotal": 1,
"queueSnapshotAt": "2026-10-22T12:00:00.000Z"
}
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.
SoundSync
Historical audience and rendered 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.
SoundSync
Read the historical enrollment outcome
| Response | Meaning |
|---|---|
| started:true | A new jobId and eligibleRecipients count were recorded. This schedules work; it does not mean messages have been sent. |
| started:false, alreadyRunning:true | The same pending configuration already has a jobId. No new job or fresh eligible count is returned. |
| started:false, eligibleRecipients:0 | No eligible recipients remain. No jobId is returned. |
| flowId / jobId | Database identifiers may arrive as positive decimal strings. Keep them intact rather than treating them as UUIDs. |
| canEnroll | Preview hint from workflow state, configuration and count. Enrollment separately checks that automation is enabled, so this is not unconditional permission to schedule. |
Multi-product triggers and saved header design
For cross_sell_upsell, use triggerProductIds or metadata.triggerProductIds for the positive product IDs that start entry. Existing single-product productId metadata remains a compatibility fallback. Keep recommendedProductIds separate. {{trigger_products}} renders matching owned trigger-product names; live paid-order enrollment groups matching items into one sequence per order.
The email-preview request accepts email.emailDesign.headerEnabled and email.emailDesign.headerLogo. A false headerEnabled removes the header; headerLogo accepts a supported HTTP(S) logo URL or an empty value to remove the image. Primary and reward messages retain separate saved designs. Preview does not send email or enroll recipients.
SoundSync
Create a purchase-reward program
/api/developer/marketing/growth-flows/purchase-rewards
Create an order-scoped reward program for owned trigger products
- Auth
- Account Bearer session token
- Scope
- marketing.view in the effective developer workspace; operation-specific audience checks still apply.
- Request fields
- title: string (required)
- productIds: array (required)
- discountType: percent | amount
- discountValue: number (required)
- codePrefix: string
- Returns
- HTTP 201: offer.
- Notes
- Creates an active post_purchase_coupon program for the owned trigger products, not a shared coupon code. Percent is the default discount type and cannot exceed 100; amount is a dollar discount. The helper sets requiredQuantity:1 and order-scoped paid grants. A qualifying paid order can issue a recipient-specific coupon. A cross-sell flow explicitly enabling includeFreeAcquisitions can instead use verified active access if the program allows free items and its quantity rules are satisfied; that grant retains entitlement provenance, not a fabricated order. This request alone does not send email, enroll an audience or issue a coupon. Existing promotion validation and marketing.manage/all-products checks apply.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"productIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"minItems": 1
},
"discountType": {
"type": "string",
"enum": [
"percent",
"amount"
]
},
"discountValue": {
"type": "number",
"exclusiveMinimum": 0
},
"codePrefix": {
"type": "string"
}
},
"required": [
"title",
"productIds",
"discountValue"
],
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"offer": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/purchase-rewards
Use the supported email-marketing compatibility mount for the same reward helper
- Auth
- Account Bearer session token
- Scope
- marketing.manage and all-products workspace scope; identical request and response contract.
- Request fields
- title: string (required)
- productIds: array (required)
- discountType: percent | amount
- discountValue: number (required)
- codePrefix: string
- Returns
- HTTP 201: offer.
- Notes
- Creates an active post_purchase_coupon program for the owned trigger products, not a shared coupon code. Percent is the default discount type and cannot exceed 100; amount is a dollar discount. The helper sets requiredQuantity:1 and order-scoped paid grants. A qualifying paid order can issue a recipient-specific coupon. A cross-sell flow explicitly enabling includeFreeAcquisitions can instead use verified active access if the program allows free items and its quantity rules are satisfied; that grant retains entitlement provenance, not a fabricated order. This request alone does not send email, enroll an audience or issue a coupon. Existing promotion validation and marketing.manage/all-products checks apply.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"productIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"minItems": 1
},
"discountType": {
"type": "string",
"enum": [
"percent",
"amount"
]
},
"discountValue": {
"type": "number",
"exclusiveMinimum": 0
},
"codePrefix": {
"type": "string"
}
},
"required": [
"title",
"productIds",
"discountValue"
],
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"offer": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
Save the reward reference, not a shared coupon
For cross_sell_upsell, send incentive:{enabled:true,type:"purchase_reward",purchaseRewardOfferId:<program ID>}. GET /api/developer/marketing/growth-flows/promo-options returns purchaseRewards separately from promoCodes and accepts selectedRewardId. Trigger products are added to the saved program transactionally; recommended products remain separate.
Send includeFreeAcquisitions:true only when the cross-sell reward should accept verified active free product access and the selected program permits free items. False retains paid-acquisition proof. Values must be JSON booleans; conflicting reward settings return GROWTH_FLOW_REWARD_FREE_ACCESS_EXCLUDED. Free grants retain entitlement provenance, while paid grants retain their order identity. Invalid, expired, revoked, unverified and fully refunded access remain ineligible; suppressions and marketing eligibility are not bypassed. These mutations are not read-only health checks.
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.
Use one Growth Flow mount consistently
The preferred /api/developer/marketing paths and active /api/developer/email-marketing compatibility paths use the same router. Methods, request fields, recipient funding-hold fields, state checks, permissions and side effects are identical. An alias is not a dry run or a different queue. Prefer the canonical paths for new clients; do not retry the same mutation through another alias as though it were new work.
SoundSync
Growth Flow compatibility operation map
/api/developer/email-marketing/growth-flows
Same contract as /api/developer/marketing/growth-flows
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- query days: integer
- query range: string. Use all for all-time metrics; otherwise days defaults to 30.
- Returns
- HTTP 200: flows, templates, queueSnapshotAt.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
Query and header parameters
[
{
"name": "days",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 3650
},
"required": false,
"description": ""
},
{
"name": "range",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "Use all for all-time metrics; otherwise days defaults to 30."
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"queueSnapshotAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/summary
Same contract as /api/developer/marketing/growth-flows/summary
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- query days: integer
- query range: string. Use all for all time; a day range such as 90d selects that window when days is omitted.
- Returns
- HTTP 200: flows, templates, rangeDays, range, activeFlows, archivedFlows, archivedActivity, totalFlows, emailsSent, revenue, conversions, queuedNow, sentTotal, failedTotal, unresolvedTotal, queueSnapshotAt, recommendations.
- Notes
- Default 30 days. Archived flows are hidden from flows but retained in totalFlows, archivedFlows, archivedActivity and aggregate history. Queue totals are a current snapshot at queueSnapshotAt, not a date-range delivery count. Revenue is attributed net product revenue after discounts and product refunds/disputes, excluding tax; it is not developer payout earnings. Internal boolean service options are not HTTP query switches.
Request, response and error reference
Query and header parameters
[
{
"name": "days",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 3650
},
"required": false,
"description": ""
},
{
"name": "range",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "Use all for all time; a day range such as 90d selects that window when days is omitted."
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"rangeDays": {
"type": [
"integer",
"null"
],
"description": "Null for range=all; otherwise the effective day count."
},
"range": {
"type": "string",
"enum": [
"all",
"days"
]
},
"activeFlows": {
"type": "integer"
},
"archivedFlows": {
"type": "integer"
},
"archivedActivity": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"emailsSent": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
}
},
"totalFlows": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"revenue": {
"type": "number"
},
"conversions": {
"type": "integer"
},
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"queueSnapshotAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"recommendations": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/templates
Same contract as /api/developer/marketing/growth-flows/templates
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: templates.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/promo-options
Same contract as /api/developer/marketing/growth-flows/promo-options
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- query search: string
- query selectedId: integer
- query selectedRewardId: integer
- Returns
- HTTP 200: promoCodes, purchaseRewards.
- Notes
- Returns static promo codes separately from purchase-reward programs. A selected inactive reward may be included for editing; it is not eligible for new reward issuance.
Request, response and error reference
Query and header parameters
[
{
"name": "search",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "selectedId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "selectedRewardId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"promoCodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"code": {
"type": "string"
},
"discountType": {
"type": "string"
},
"discountValue": {
"type": "number"
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"purchaseRewards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"title": {
"type": "string"
},
"discountType": {
"type": "string"
},
"discountValue": {
"type": "number"
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows
Same contract as /api/developer/marketing/growth-flows
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- name: string
- status: draft | active | paused | archived
- triggerType: string
- segmentId: integer
- campaignId: integer
- delayMinutes: integer
- quietHoursStrategy: defer | skip | ignore
- smartTimingEnabled: boolean
- suppressionPolicy: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- messageTemplate: object
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- type: string (required)
- description: string
- audienceId: integer
- productId: integer
- includeFreeAcquisitions: boolean. For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program.
- relatedProductIds: array
- promotionId: integer
- inactiveDays: integer
- setupUrl: string
- releaseUrl: string
- version: string
- downloadUrl: string
- recommendedProductUrl: string
- incentive: object
- sequence: array
- Returns
- HTTP 201: flow.
- Notes
- includeFreeAcquisitions must be a JSON boolean at top level or in metadata; a supplied top-level boolean takes precedence. Supported access flows include cross_sell_upsell, review_request, product_onboarding and product_update. Cross-sell and configured review/onboarding flows can respond to qualifying access events. Product-update audience eligibility does not make a grant a release trigger: a product-update event or deliberately reviewed history enrollment is still required. Saving the setting alone does not replay history or send messages. Explicit false retains paid-acquisition proof. A purchase-reward flow needs explicit true plus a program permitting free items; a conflicting program is rejected. Active recipient-owned access, popup verification, current state/expiry, enrollment eligibility and suppression checks remain required. Free access and reward coupons do not become paid orders. Retry of the same acquisition/program reuses its reward.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true,
"required": [
"type"
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
Operation errors: GROWTH_FLOW_ACQUISITION_SETTING_INVALID, GROWTH_FLOW_REWARD_FREE_ACCESS_EXCLUDED.
/api/developer/email-marketing/growth-flows/{flowId}
Same contract as /api/developer/marketing/growth-flows/{flowId}
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: flow.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/recipients
Same contract as /api/developer/marketing/growth-flows/{flowId}/recipients
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- query page: integer
- query limit: integer
- query search: string
- query status: string
- query emailNumber: integer
- Returns
- HTTP 200: recipients, pagination, search, status, emailNumber.
- Notes
- For status=queued, inspect sendHoldCode, failureReason and nextRetryAt separately from scheduledFor. A funding hold keeps the planned date and uses a separate retry deadline, normally set 15 minutes after the deferred attempt. Worker selection and claim both respect that deadline. Once funding and spend checks succeed, held work can retry automatically; provider availability, active flow, consent, ownership and queue eligibility still apply. Do not reset the flow or use Retry unconfirmed for an ordinary funding pause. The row may remain queued while sending is paused; a past scheduledFor is not proof of a send.
Request, response and error reference
Query and header parameters
[
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "search",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "status",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "emailNumber",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"recipients": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"workflowId": {
"type": "integer",
"minimum": 1
},
"email": {
"type": "string",
"format": "email"
},
"name": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"status": {
"type": "string"
},
"failureReason": {
"type": [
"string",
"null"
]
},
"scheduledFor": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Planned send date. For a queued funding hold, preserves not_before when recorded, otherwise scheduled_for; not the next funding-retry time."
},
"sendHoldCode": {
"type": [
"string",
"null"
],
"description": "Queued spend/funding hold code, otherwise null. A hold is not provider acceptance or delivery_unknown."
},
"nextRetryAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Queued funding retry eligibility from spendHoldRetryAt, with a legacy scheduled_for fallback. Otherwise null. Not a guaranteed send time."
},
"sentAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"sendAttemptAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"deliveryReviewedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"deliveryReviewOutcome": {
"type": [
"string",
"null"
]
},
"deliveryReviewComplete": {
"type": "boolean"
},
"deliveryReviewEventsScanned": {
"type": "integer"
},
"retryUnconfirmedAllowed": {
"type": "boolean"
},
"productName": {
"type": "string"
},
"productRole": {
"type": "string"
}
},
"additionalProperties": true
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"total": {
"type": "integer"
},
"totalPages": {
"type": "integer"
}
},
"additionalProperties": true
},
"search": {
"type": "string"
},
"status": {
"type": "string"
},
"emailNumber": {
"type": [
"integer",
"null"
]
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}
Same contract as /api/developer/marketing/growth-flows/{flowId}
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- name: string
- status: draft | active | paused | archived
- triggerType: string
- segmentId: integer
- campaignId: integer
- delayMinutes: integer
- quietHoursStrategy: defer | skip | ignore
- smartTimingEnabled: boolean
- suppressionPolicy: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- messageTemplate: object
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- type: string
- description: string
- audienceId: integer
- productId: integer
- includeFreeAcquisitions: boolean. For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program.
- relatedProductIds: array
- promotionId: integer
- inactiveDays: integer
- setupUrl: string
- releaseUrl: string
- version: string
- downloadUrl: string
- recommendedProductUrl: string
- incentive: object
- sequence: array
- Returns
- HTTP 200: flow.
- Notes
- includeFreeAcquisitions must be a JSON boolean at top level or in metadata; a supplied top-level boolean takes precedence. Supported access flows include cross_sell_upsell, review_request, product_onboarding and product_update. Cross-sell and configured review/onboarding flows can respond to qualifying access events. Product-update audience eligibility does not make a grant a release trigger: a product-update event or deliberately reviewed history enrollment is still required. Saving the setting alone does not replay history or send messages. Explicit false retains paid-acquisition proof. A purchase-reward flow needs explicit true plus a program permitting free items; a conflicting program is rejected. Active recipient-owned access, popup verification, current state/expiry, enrollment eligibility and suppression checks remain required. Free access and reward coupons do not become paid orders. Retry of the same acquisition/program reuses its reward.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
Operation errors: GROWTH_FLOW_ACQUISITION_SETTING_INVALID, GROWTH_FLOW_REWARD_FREE_ACCESS_EXCLUDED.
/api/developer/email-marketing/growth-flows/{flowId}/activate
Same contract as /api/developer/marketing/growth-flows/{flowId}/activate
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: flow.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/pause
Same contract as /api/developer/marketing/growth-flows/{flowId}/pause
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: flow.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/duplicate
Same contract as /api/developer/marketing/growth-flows/{flowId}/duplicate
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 201: flow.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
No request body fields are read by this operation.
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/archive
Same contract as /api/developer/marketing/growth-flows/{flowId}/archive
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: flow.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/run
Same contract as /api/developer/marketing/growth-flows/{flowId}/run
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: flow, signal, launched.
- Notes
- Launches supported manual audience work. No eligible audience means no permission to send to suppressed contacts.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
},
"signal": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"launched": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/preview
Same contract as /api/developer/marketing/growth-flows/{flowId}/preview
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: flow.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/test-email
Same contract as /api/developer/marketing/growth-flows/{flowId}/test-email
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- emailNumber: integer
- email: string
- to: string
- Returns
- HTTP 200: sent.
- Notes
- The recipient must be the signed-in developer. Select a valid sequence step; sender/footer readiness still applies.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"emailNumber": {
"type": "integer",
"minimum": 1
},
"email": {
"type": "string",
"format": "email"
},
"to": {
"type": "string",
"format": "email"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"sent": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/templates/{type}/activate
Same contract as /api/developer/marketing/growth-flows/templates/{type}/activate
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: flow, created.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
},
"created": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/templates/{type}/pause
Same contract as /api/developer/marketing/growth-flows/templates/{type}/pause
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: flow, created.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here.",
"properties": {
"includeFreeAcquisitions": {
"type": "boolean"
}
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"audienceId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"includeFreeAcquisitions": {
"type": "boolean",
"description": "For supported product-access flows, explicit true admits verified active free access; false requires qualifying paid acquisition. Omission preserves the existing flow/default behavior. A supplied top-level boolean takes precedence over metadata.includeFreeAcquisitions. Product-update audience eligibility does not make an access grant a release trigger. Purchase-reward flows remain paid-only unless explicitly enabled and allowed by the reward program."
},
"relatedProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"promotionId": {
"type": "integer",
"minimum": 1
},
"inactiveDays": {
"type": "integer"
},
"setupUrl": {
"type": "string"
},
"releaseUrl": {
"type": "string"
},
"version": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"recommendedProductUrl": {
"type": "string"
},
"incentive": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
},
"purchaseRewardOfferId": {
"type": "integer",
"minimum": 1
},
"promoCodeId": {
"type": "integer",
"minimum": 1
},
"promoCode": {
"type": "string"
},
"discountLabel": {
"type": "string"
}
},
"additionalProperties": true
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"delayMinutes": {
"type": "integer"
},
"emailNumber": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
},
"metrics": {
"type": "object",
"properties": {
"queuedNow": {
"type": "integer"
},
"sentTotal": {
"type": "integer"
},
"failedTotal": {
"type": "integer"
},
"unresolvedTotal": {
"type": "integer"
},
"emailsSent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"conversions": {
"type": "integer"
},
"revenue": {
"type": "number"
}
},
"additionalProperties": true
},
"stepMetrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
},
"created": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/settings
Same contract as /api/developer/marketing/automation/settings
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: settings.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"automation_enabled": {
"type": "boolean"
},
"quiet_hours_enabled": {
"type": "boolean"
},
"quiet_hours_start": {
"type": "string"
},
"quiet_hours_end": {
"type": "string"
},
"timezone": {
"type": "string"
},
"smart_send_window_enabled": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/settings
Same contract as /api/developer/marketing/automation/settings
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- automationEnabled: boolean
- quietHoursEnabled: boolean
- quietHoursStart: string
- quietHoursEnd: string
- timezone: string
- smartSendWindowEnabled: boolean
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- HTTP 200: settings.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"automationEnabled": {
"type": "boolean"
},
"quietHoursEnabled": {
"type": "boolean"
},
"quietHoursStart": {
"type": "string"
},
"quietHoursEnd": {
"type": "string"
},
"timezone": {
"type": "string"
},
"smartSendWindowEnabled": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"automation_enabled": {
"type": "boolean"
},
"quiet_hours_enabled": {
"type": "boolean"
},
"quiet_hours_start": {
"type": "string"
},
"quiet_hours_end": {
"type": "string"
},
"timezone": {
"type": "string"
},
"smart_send_window_enabled": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/workflows
Same contract as /api/developer/marketing/automation/workflows
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- query status: string
- query triggerType: string
- query limit: integer
- Returns
- HTTP 200: workflows.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
Query and header parameters
[
{
"name": "status",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "triggerType",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"workflows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"trigger_type": {
"type": "string"
},
"segment_id": {
"type": "integer",
"minimum": 1
},
"campaign_id": {
"type": "integer",
"minimum": 1
},
"delay_minutes": {
"type": "integer"
},
"quiet_hours_strategy": {
"type": "string"
},
"smart_timing_enabled": {
"type": "boolean"
},
"suppression_policy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"message_template": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/workflows
Same contract as /api/developer/marketing/automation/workflows
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- name: string (required)
- status: draft | active | paused | archived
- triggerType: string (required)
- segmentId: integer
- campaignId: integer
- delayMinutes: integer
- quietHoursStrategy: defer | skip | ignore
- smartTimingEnabled: boolean
- suppressionPolicy: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- messageTemplate: object
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- HTTP 201: workflow.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true,
"required": [
"name",
"triggerType"
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"trigger_type": {
"type": "string"
},
"segment_id": {
"type": "integer",
"minimum": 1
},
"campaign_id": {
"type": "integer",
"minimum": 1
},
"delay_minutes": {
"type": "integer"
},
"quiet_hours_strategy": {
"type": "string"
},
"smart_timing_enabled": {
"type": "boolean"
},
"suppression_policy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"message_template": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/workflows/{workflowId}
Same contract as /api/developer/marketing/automation/workflows/{workflowId}
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- name: string
- status: draft | active | paused | archived
- triggerType: string
- segmentId: integer
- campaignId: integer
- delayMinutes: integer
- quietHoursStrategy: defer | skip | ignore
- smartTimingEnabled: boolean
- suppressionPolicy: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- messageTemplate: object
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- HTTP 200: workflow.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"triggerType": {
"type": "string"
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"campaignId": {
"type": "integer",
"minimum": 1
},
"delayMinutes": {
"type": "integer",
"minimum": 0
},
"quietHoursStrategy": {
"type": "string",
"enum": [
"defer",
"skip",
"ignore"
]
},
"smartTimingEnabled": {
"type": "boolean"
},
"suppressionPolicy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messageTemplate": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyHtml": {
"type": "string"
},
"bodyText": {
"type": "string"
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"trigger_type": {
"type": "string"
},
"segment_id": {
"type": "integer",
"minimum": 1
},
"campaign_id": {
"type": "integer",
"minimum": 1
},
"delay_minutes": {
"type": "integer"
},
"quiet_hours_strategy": {
"type": "string"
},
"smart_timing_enabled": {
"type": "boolean"
},
"suppression_policy": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"message_template": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/suppression-rules
Same contract as /api/developer/marketing/automation/suppression-rules
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- query workflowId: integer
- Returns
- HTTP 200: rules.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
Query and header parameters
[
{
"name": "workflowId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"workflow_id": {
"type": "integer",
"minimum": 1
},
"rule_type": {
"type": "string"
},
"product_id": {
"type": "integer",
"minimum": 1
},
"segment_id": {
"type": "integer",
"minimum": 1
},
"cooldown_hours": {
"type": "integer"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/workflows/{workflowId}/suppression-rules
Same contract as /api/developer/marketing/automation/workflows/{workflowId}/suppression-rules
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- ruleType: string (required)
- productId: integer
- segmentId: integer
- cooldownHours: integer
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- HTTP 201: rule.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"ruleType": {
"type": "string"
},
"productId": {
"type": "integer",
"minimum": 1
},
"segmentId": {
"type": "integer",
"minimum": 1
},
"cooldownHours": {
"type": "integer"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"required": [
"ruleType"
],
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"rule": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/queue
Same contract as /api/developer/marketing/automation/queue
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- query status: string
- query workflowId: integer
- query limit: integer
- Returns
- HTTP 200: queue.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
Query and header parameters
[
{
"name": "status",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "workflowId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"queue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"workflow_id": {
"type": "integer",
"minimum": 1
},
"email": {
"type": "string",
"format": "email"
},
"status": {
"type": "string"
},
"scheduled_for": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"sent_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"failure_reason": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/audit-events
Same contract as /api/developer/marketing/automation/audit-events
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- query workflowId: integer
- query limit: integer
- Returns
- HTTP 200: auditEvents.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
Query and header parameters
[
{
"name": "workflowId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"auditEvents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"workflow_id": {
"type": "integer",
"minimum": 1
},
"event_type": {
"type": "string"
},
"message": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/signals
Same contract as /api/developer/marketing/automation/signals
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- query signalType: string
- query limit: integer
- Returns
- HTTP 200: signals, windows.
- Notes
- Active compatibility mount of the same marketing router, with identical operation-specific authorization and state handling. Prefer the canonical /api/developer/marketing route for new integrations; the alias does not bypass marketing.manage, product scope or all-products requirements.
Request, response and error reference
Query and header parameters
[
{
"name": "signalType",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"signals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"signal_type": {
"type": "string"
},
"product_id": {
"type": "integer",
"minimum": 1
},
"occurred_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"windows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/signals/test
Same contract as /api/developer/marketing/automation/signals/test
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- signalType: string (required)
- customerId: integer
- developerCustomerId: integer
- productId: integer
- entitlementId: integer
- serialId: integer
- email: string
- source: string
- sourceId: string
- signalCount: integer
- occurredAt: string,null
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- HTTP 201: signal, queued.
- Notes
- This is not a dry-run endpoint: a signal can queue eligible workflow work. Current permission, consent and suppression rules still apply.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"signalType": {
"type": "string"
},
"customerId": {
"type": "integer",
"minimum": 1
},
"developerCustomerId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"entitlementId": {
"type": "integer",
"minimum": 1
},
"serialId": {
"type": "integer",
"minimum": 1
},
"email": {
"type": "string",
"format": "email"
},
"source": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"signalCount": {
"type": "integer"
},
"occurredAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"required": [
"signalType"
],
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"signal": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"queued": {
"type": "integer"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/automation/process
Same contract as /api/developer/marketing/automation/process
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- limit: integer
- Returns
- HTTP 200: processed, deliveryUnknown, usageReconciled, sent, skipped, failed, deferred.
- Notes
- Processes real eligible queued work for the workspace. Do not use as a health check.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"processed": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"deliveryUnknown": {
"type": "integer"
},
"usageReconciled": {
"type": "integer"
},
"sent": {
"type": "integer"
},
"skipped": {
"type": "integer"
},
"failed": {
"type": "integer"
},
"deferred": {
"type": "integer"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/recipients/{queueId}/review
Same contract as /api/developer/marketing/growth-flows/{flowId}/recipients/{queueId}/review
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: status, message, checkedAt, outcome, eventsScanned, retryEligible.
- Notes
- Persists a provider-history review. A matching acceptance marks sent without resending. Incomplete, ambiguous or unavailable history stays on hold.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"checkedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"outcome": {
"type": "string"
},
"eventsScanned": {
"type": "integer"
},
"retryEligible": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/recipients/{queueId}/retry
Same contract as /api/developer/marketing/growth-flows/{flowId}/recipients/{queueId}/retry
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Returns
- HTTP 200: status, message, checkedAt, outcome, eventsScanned, retryEligible.
- Notes
- Only a confirmed failed, unsent recipient is eligible. Requires an active flow and no recorded delivery. Sending rechecks consent, suppression and queue rules.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"checkedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"outcome": {
"type": "string"
},
"eventsScanned": {
"type": "integer"
},
"retryEligible": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/developer/email-marketing/growth-flows/{flowId}/recipients/{queueId}/retry-unconfirmed
Same contract as /api/developer/marketing/growth-flows/{flowId}/recipients/{queueId}/retry-unconfirmed
- Auth
- Account Bearer session token
- Scope
- The operation-specific account, workspace, product and ownership checks apply.
- Request fields
- acknowledgeDuplicateRisk: true (required)
- Returns
- HTTP 200: status, message, checkedAt, outcome, eventsScanned, retryEligible.
- Notes
- Rechecks provider history before requeueing. Requires delivery_unknown, a complete unconfirmed review at least 125 minutes after the recorded attempt, no provider message/transaction IDs, no sent/opened/clicked event, and an active flow. A duplicate remains possible. Concurrent review/state changes reject the retry.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"acknowledgeDuplicateRisk": {
"const": true
}
},
"required": [
"acknowledgeDuplicateRisk"
],
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"checkedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"outcome": {
"type": "string"
},
"eventsScanned": {
"type": "integer"
},
"retryEligible": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: GROWTH_FLOW_DUPLICATE_RISK_ACK_REQUIRED, GROWTH_FLOW_UNCONFIRMED_RETRY_NOT_ALLOWED, GROWTH_FLOW_REVIEW_CHANGED, GROWTH_FLOW_INACTIVE, GROWTH_FLOW_DELIVERY_RECORDED, GROWTH_FLOW_RECIPIENT_NOT_FOUND.
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
