Skip to main content
All errors follow:
{
  "error": {
    "code": "invalid_query_parameter",
    "message": "Human-readable summary."
  },
  "meta": { "requestId": "..." }
}
Always cite meta.requestId when reporting issues to Soundlink. Using the TypeScript SDK? API errors arrive as { data: null, error } on every method — see Access the API with TypeScript. Thrown SoundlinkSdkError subclasses are only for config, parse, and transport failures.

Common codes

HTTPCodeWhen
401invalid_api_keyMissing or malformed x-api-key
401api_key_revokedKey revoked
401api_key_expiredKey past expires_at
401mixed_credentialsBearer + x-api-key on the same request
403insufficient_scopeValid key missing route scope
404not_foundUnknown path or Public API disabled for org
404campaign_not_foundUnknown campaign or other org’s campaign
400invalid_query_parameterBad pagination or sort params
400invalid_date_rangeendDate before startDate
400page_size_exceededpageSize above endpoint max
429rate_limit_exceededPer-key rate limit (honor Retry-After)
500internal_errorUnexpected failure — retry with backoff

Pagination limits

  • Campaign list: pageSize max 100
  • Metrics breakdown list: pageSize max 500 (see endpoint docs)