API Reference
Email Marketing API
Developer-authenticated contacts, suppressions, campaigns, automation, AI draft, usage, and unsubscribe endpoints.
SoundSync
Verified endpoints
These endpoints are route-backed in the current platform.
GET
/api/developer/email-marketing/settings
Fetch marketing settings.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- Returns
- settings.
- Side effects
- None for read endpoints unless noted.
PATCH
/api/developer/email-marketing/settings
Update marketing settings.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- settings body
- Returns
- updated settings.
- Side effects
- Writes marketing settings.
GET
/api/developer/email-marketing/contacts
List marketing contacts.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- pagination/filter query
- Returns
- contacts[].
- Side effects
- None for read endpoints unless noted.
POST
/api/developer/email-marketing/contacts/import/preview
Preview contact import.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- CSV/rows body
- Returns
- preview rows/errors.
- Side effects
- None for read endpoints unless noted.
POST
/api/developer/email-marketing/contacts/import
Import subscribers.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- subscriber rows
- Returns
- import result.
- Side effects
- Creates/updates subscribers with consent metadata.
GET
/api/developer/email-marketing/suppressions
List suppressions.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- Returns
- suppression rows.
- Side effects
- None for read endpoints unless noted.
GET
/api/developer/email-marketing/campaigns
List campaigns.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- Returns
- campaigns[].
- Side effects
- None for read endpoints unless noted.
POST
/api/developer/email-marketing/campaigns
Create campaign draft.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- name/subject/body/audience fields
- Returns
- 201 campaign.
- Side effects
- Creates campaign draft.
PATCH
/api/developer/email-marketing/campaigns/:campaignId
Update campaign.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- campaignId
- fields body
- Returns
- updated campaign.
- Side effects
- Updates campaign draft/scheduled campaign when allowed.
POST
/api/developer/email-marketing/campaigns/:campaignId/test
Send test email.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- recipient body
- Returns
- test-send result.
- Side effects
- Sends test email when provider configured.
POST
/api/developer/email-marketing/campaigns/:campaignId/send-now
Send campaign now.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- Returns
- send result.
- Side effects
- Queues/sends campaign.
POST
/api/developer/email-marketing/campaigns/:campaignId/schedule
Schedule campaign.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- schedule time
- Returns
- schedule result.
- Side effects
- Schedules campaign.
GET
/api/developer/email-marketing/usage
Fetch email marketing usage.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- Returns
- usage summary.
- Side effects
- None for read endpoints unless noted.
GET
/unsubscribe
Marketing unsubscribe entry route.
- Auth
- Public unsubscribe token/link context.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- token/query context as implemented
- Returns
- Unsubscribe page/action response.
- Side effects
- May record unsubscribe/suppression when valid.
SoundSync
Campaigns, contacts, reporting, and assistance
Current route and service contracts. Examples below are illustrative; live provider outcomes and client-host testing are separate checks.
GET
/api/developer/marketing/summary
Read marketing home totals and current activity.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Supported date, state, or pagination filters where applicable
- Returns
- Operation result or scoped records.
- Side effects
- Read-only unless the operation explicitly records referral activity.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/audience/estimate
Estimate eligible recipients before sending.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
GET
/api/developer/marketing/contacts/import/demo.csv
Download the contact-import sample.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Supported date, state, or pagination filters where applicable
- Returns
- CSV sample.
- Side effects
- Read-only unless the operation explicitly records referral activity.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
GET
/api/developer/marketing/segments
List saved segments.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Supported date, state, or pagination filters where applicable
- Returns
- Operation result or scoped records.
- Side effects
- Read-only unless the operation explicitly records referral activity.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/segments
Create a scoped saved segment.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
PATCH
/api/developer/marketing/segments/:segmentId
Update a saved segment.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
DELETE
/api/developer/marketing/segments/:segmentId
Remove a saved segment.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
PATCH
/api/developer/marketing/contacts/bulk-suppress
Suppress a selected audience under all-products permission.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
PATCH
/api/developer/marketing/contacts/:id/consent
Record a permitted consent change.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
PATCH
/api/developer/marketing/contacts/:id/suppress
Suppress or resolve the selected contact under the permitted workflow.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/scheduled-deals/:dealId/campaign-draft
Prepare a campaign draft from a deal; does not send it.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/ai/generate-draft
Prepare an AI-assisted campaign draft.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/ai/generate-subjects
Generate subject suggestions.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/ai/generate-preview-text
Generate preview-text suggestions.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/ai/rewrite
Rewrite supplied draft content.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/ai/generate-banner
Request campaign banner assistance.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/ai/generate-scheduled-deal-draft
Prepare an AI-assisted deal campaign draft.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
GET
/api/developer/marketing/campaigns/:campaignId
Read a campaign and its current state.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- campaignId path
- Supported date, state, or pagination filters where applicable
- Returns
- Operation result or scoped records.
- Side effects
- Read-only unless the operation explicitly records referral activity.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
DELETE
/api/developer/marketing/campaigns/:campaignId
Delete a campaign when its state allows.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- campaignId path
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/campaigns/:campaignId/duplicate
Duplicate for review with a new schedule.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- campaignId path
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/campaigns/:campaignId/preview
Render content without sending to an audience.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- campaignId path
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/campaigns/:campaignId/resume-send
Resume supported interrupted sending after checking recipient outcomes.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- campaignId path
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
POST
/api/developer/marketing/campaigns/:campaignId/cancel
Cancel supported pending campaign work.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- campaignId path
- Operation-specific campaign, audience, contact, or draft input
- Returns
- Operation result or scoped records.
- Side effects
- Performs the described operation; review confirmation and retry requirements.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
GET
/api/developer/marketing/campaigns/latest/report
Read the latest campaign report.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- Relevant path identifier where present
- Supported date, state, or pagination filters where applicable
- Returns
- Operation result or scoped records.
- Side effects
- Read-only unless the operation explicitly records referral activity.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
GET
/api/developer/marketing/campaigns/:campaignId/recipients
Inspect per-recipient outcomes with query filters.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- campaignId path
- Supported date, state, or pagination filters where applicable
- Returns
- Operation result or scoped records.
- Side effects
- Read-only unless the operation explicitly records referral activity.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
GET
/api/developer/marketing/campaigns/:campaignId/report
Read campaign delivery, engagement, and attribution context.
- Auth
- Developer Bearer JWT with the applicable marketing permission and product scope.
- Scope
- Authenticated account, workspace, relationship, and product ownership checks apply.
- Request fields
- campaignId path
- Supported date, state, or pagination filters where applicable
- Returns
- Operation result or scoped records.
- Side effects
- Read-only unless the operation explicitly records referral activity.
- Notes
- Marketing-view access is required; applicable mutation, contact, consent, and all-products checks remain enforced. AI, preview, and draft creation do not authorize sending.
SoundSync