Sonos Music API > refreshAuthToken

Sonos sends refreshAuthToken to renew a token when an HTTP REST request returns a 401 error. See Use authentication tokens for details.

Request parameters




Name Type Description
authToken string The authorization token for the household.
privateKey string Additional information associated with a specific authorization token that allows the token to be refreshed.
userInfo complex (Optional, but recommended) Use this object to return the user’s nickname on your service. The Sonos app will pre-populate this nickname for the account holder when they add your service to their Sonos household. See SMAPI object types for details.

Sample request

Sample valid response

Sample valid response with userInfo