Skip to content
SoundSyncAudio software platform

API Reference

Email Marketing API

Developer-authenticated contacts, suppressions, campaigns, automation, AI draft, usage, and unsubscribe endpoints.

Start with getting startedExplore API docs
POST /activateGET /validatePOST /deactivate
Product credentials
Activation request
Entitlement check
Device registration
Periodic validation
Deactivation when needed
Live Moonwave FX email marketing workspace showing campaign, audience, and marketing controls.

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.

API reference

Endpoint groups are organized by authentication model, product scope, request shape, response shape, errors, idempotency, and integration surface.

GET/POST/PATCH

Email Marketing API

/docs/api/email-marketing

Contacts, campaigns, automation, and usage.