account

Update account settings

Changed on
post/v1/account.updateSettings

Request

  • Base URL: https://api.steamsets.com
  • URL: https://api.steamsets.com/v1/account.updateSettings
  • Auth: HTTP bearer

Headers

X-Forwarded-Forstring
X-Shield-Shiba-Tokenstring

ShieldShiba token the widget issued for exactly the new email. Required when email changes to a non-empty address. It is redeemed once and expires after 5 minutes

Request body

$schemastring uri

A URL to the JSON Schema for this object.

countryOverridestring nullable

The country name or code to override the Steam country with. Empty string clears it, omit to leave unchanged

emailstring nullable

The email the account should use. Empty string clears it, omit to leave unchanged. A new address needs the X-Shield-Shiba-Token header

hiddenboolean nullable

Whether the account should be hidden in the leaderboards. Omit to leave unchanged

hiddenReasonstring nullable

Why the account is hidden, in the user's own words. Required when hidden changes to true: at least 10 characters, in words

languagestring nullable

The language the account should use. Omit to leave unchanged

nameEffect'none' | 'rainbow' | 'glitch' | 'shadow' | 'neon' | 'retro' | 'stamped' | 'shatter' | 'typewriter' | 'vaporwave' | 'sunken' nullable

The name effect. none clears it, omit to leave unchanged

themeColorstring nullable

The profile theme color as #RRGGBB (no alpha). Empty string clears it, omit to leave unchanged

vanitystring nullable

The vanity the account should use. Empty string clears it, omit to leave unchanged

Example request

{
  "$schema": "https://api.steamsets.com/schemas/V1AccountUpdateSettingsRequestBody.json",
  "email": "steamsets@example.com",
  "hidden": true,
  "hiddenReason": "People keep messaging me about my badges",
  "language": "en",
  "nameEffect": "rainbow",
  "themeColor": "#FF5733",
  "vanity": "flo"
}

Response

No Content

Changes