Reset Locale

POST

/account/languages/reset_locale

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/account/languages/reset_locale \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "default_locale": "fr", "locale": "fr" }'

• Production

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.

Note: 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.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

default_locale

locale

Example

{
  "default_locale": "fr",
  "locale": "fr"
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}