Skip to content

Reset a language to defaults

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

POST/account/languages/reset_locale

Costs 2 rate-limit points · Rate limits

Replace one language's widget and alert copy with STOQ's default text in that language, as the translation pages' reset does. With default_locale, first make that the language customers get alerts and the widget in, as the Settings page's language picker does.

Overwrites the copy the merchant wrote in that language. Other languages are left alone. locale is the language reset; omitted, it is default_locale when sent, else the shop's default language.

Also searched asdefault alert languagechange alert languagechange customer languagereset translationsrestore default text

Headers

  • Idempotency-Keystring

    A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

  • default_localestring

    Make this the language customers get alerts and the widget in.

    One of bgcsdadeenesetfifrhuiditjakonbnlplpt-BRpt-PTrorusvtrvizhzh-TW
  • localestring

    The language whose copy is reset.

    One of bgcsdadeenesetfifrhuiditjakonbnlplpt-BRpt-PTrorusvtrvizhzh-TW

Returns

  • default_localestring
    Example: fr
  • app_localestring
    Example: en
  • multi_language_enabledboolean
    Example: true
  • product_translations_enabledboolean
    Example: true
  • reset_localestring
    Example: fr

Errors

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

POST/account/languages/reset_locale
curl -X POST "https://app.stoqapp.com/api/v2/external/account/languages/reset_locale" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "default_locale": "fr"
  }'
Response
{
  "default_locale": "fr",
  "app_locale": "en",
  "multi_language_enabled": true,
  "product_translations_enabled": true,
  "reset_locale": "fr"
}