API Reference
Brand, Domains, and Reviews API
Developer-authenticated Brand Manager, custom domain, DNS workflow, and review moderation endpoints.
Product credentials
Activation request
Entitlement check
Device registration
Periodic validation
Deactivation when needed
SoundSync
Verified endpoints
These endpoints are route-backed in the current platform.
/api/developer/branding
Fetch Brand Manager payload.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- Returns
- branding, publicBranding, storefrontDomain, emailDomains, linkValidation, domainDocs.
- Side effects
- None for read endpoints unless noted.
/api/developer/branding
Update Brand Manager fields.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- store/name/color/logo/support/social/url/email fields
- Returns
- updated branding payload.
- Side effects
- Writes developer branding.
/api/developer/branding/custom-domain
Start/connect storefront custom domain from Brand Manager.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- domain/customDomain
- Returns
- 201 branding payload with storefrontDomainResult.
- Side effects
- Creates storefront domain row and updates branding domain status.
/api/developer/branding/email-domain
Start/connect email sending domain from Brand Manager.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- domain/sendingDomain
- Returns
- 201 branding payload with emailDomainResult.
- Side effects
- Creates email domain row and updates branding sending-domain status.
/api/developer/brand/domain
Fetch smart/manual brand-domain state.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- Returns
- current step, provider, required DNS records, events.
- Side effects
- None for read endpoints unless noted.
/api/developer/brand/domain/start
Start smart/manual DNS workflow.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- domain/body
- Returns
- 201 domain workflow state.
- Side effects
- Creates or initializes brand domain workflow.
/api/developer/brand/domain/check-step
Check one DNS setup step.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- stepKey
- Returns
- step verification result.
- Side effects
- None for read endpoints unless noted.
/api/developer/reviews
List product reviews visible to developer.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- status/productId/filter query
- Returns
- reviews[].
- Side effects
- None for read endpoints unless noted.
/api/developer/reviews/:reviewId
Update review moderation/status fields.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- reviewId
- status/body
- Returns
- updated review.
- Side effects
- Updates developer-owned review status/content metadata.
/api/developer/reviews/:reviewId/:action
Apply review action approve/publish/hide/reject/pending.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- reviewId/action
- Returns
- updated review.
- Side effects
- Updates review moderation status.
API reference
Endpoint groups are organized by authentication model, product scope, request shape, response shape, errors, idempotency, and integration surface.
Brand, Domains, and Reviews API
/docs/api/brand-domains-reviews
Brand Manager, custom domains, DNS workflow, and review moderation.