Skip to content
SoundSyncAudio software platform

Guide

Branding Workspace API

Read and save Identity, Visuals, or Support without overwriting unrelated brand settings.

Section and permission scope

Use the developer session with all-products scope. Reading requires brand-view permission and saving requires brand-management permission. Support also requires customer-view permission. Supported section values are identity, visuals, and support; domain connection endpoints remain separate.

SoundSync

Versioned section operations

GET /api/developer/branding/workspace/:section

Read the current section

Auth
Authenticated developer session
Scope
Workspace permissions and product assignments are checked.
Returns
branding, supportCenter (for support), version, uploadMaxBytes, and canManage.
PUT /api/developer/branding/workspace/:section

Save the reviewed section version

Auth
Authenticated developer session
Scope
Workspace permissions and product assignments are checked.
Request fields
  • version: exact value from the last read; values: supported section fields.
  • Identity: storeName, tagline, shortDescription, developerDisplayName, marketplaceBio and supported applyFields.
  • Visuals: logos and colors objects. Support: public contact fields, private form route, articles, links, and supported display settings.
Returns
Updated branding/supportCenter/version; stale input returns 409 BRANDING_EDIT_CONFLICT.

SoundSync

Save an identity change

Save an identity change
curl -X PUT "$SOUNDSYNC_ORIGIN/api/developer/branding/workspace/identity" \
  -H "Authorization: Bearer $DEVELOPER_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"version":"VERSION_FROM_GET","values":{"tagline":"Audio tools for your next record"}}'

Conflict, validation, and privacy

On 409, retain the local edits, read the current version, and let the editor resolve the difference. Do not silently replay an old payload under a new version. Enabled contact forms need a valid route; published help answers need content. Private form-delivery addresses must not be exposed in storefront configuration or screenshots.