Set up texts for a language

POST/settings/texts/setup

Costs 2 rate-limit points · Rate limits

Set up a language, as the settings Translate view's "Translate" does: fill every customer-facing text in locale with Filemonk's own translation (from_locale, default the same locale). Answers with that locale's texts after the fill. Send it first without confirm. Nothing changes and the 409 confirmation_required says what would. Tell the merchant, ask, and resend with confirm: true only after they agree.

Overwrites every text in that locale, including ones the merchant edited, so without confirm: true nothing changes: 409 confirmation_required says how many texts would be replaced. setup_locales on GET /settings/texts lists the languages Filemonk has a translation for.

Also searched asset up frenchtranslate everything to germanadd a languagereset translations

Request body

localestring
Example: fr
from_localestring
Example: fr
confirmboolean
Example: true

Returns

localestring, nullable
Example: fr
from_localestring, nullable
Example: fr
textsobject
Show 2 child attributesHide child attributes
- emailobject
  Show 2 child attributesHide child attributes
  - subjectstring, nullable
    Example: Vos téléchargements sont prêts
  - buttonobject
    Show 1 child attributeHide child attributes
    textstring, nullable
    Example: Télécharger
- download_pageobject
  Show 1 child attributeHide child attributes
  - textsobject
    Show 2 child attributesHide child attributes
    thanksstring, nullable
    Example: Merci pour votre commande
    buttonany
untranslatedarray of anys

Errors

401

Missing or invalid API key.

409

The request conflicts with the current state (an order Shopify is not ready to fulfil, a digital product that already exists). Nothing was changed; read the message, don't retry blindly.

422

The request failed validation, or sent a key the action does not take (code: "unknown_parameters" with unknown and accepted). Nothing was saved.

429

Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time the window ends); a 429 adds Retry-After (seconds), retry_after, retryable: true and a next_step in the body. A 429 did nothing: wait retry_after seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with per_page over many single reads.

Every error has the same shape: see Errors.

POST/settings/texts/setup

curl -X POST "https://app.filemonk.io/api/v2/external/settings/texts/setup" \
  -H "X-Auth-Token: $FILEMONK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "locale": "fr",
    "from_locale": "fr",
    "confirm": true
  }'

const res = await fetch("https://app.filemonk.io/api/v2/external/settings/texts/setup", {
  method: "POST",
  headers: {
    "X-Auth-Token": process.env.FILEMONK_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "locale": "fr",
    "from_locale": "fr",
    "confirm": true
  }),
});
const data = await res.json();

import os
import requests

res = requests.post(
    "https://app.filemonk.io/api/v2/external/settings/texts/setup",
    headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
    json={
        "locale": "fr",
        "from_locale": "fr",
        "confirm": True
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.filemonk.io/api/v2/external/settings/texts/setup")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"], "Content-Type" => "application/json")
req.body = {
  locale: "fr",
  from_locale: "fr",
  confirm: true
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

{
  "locale": "fr",
  "from_locale": "fr",
  "texts": {
    "email": {
      "subject": "Vos téléchargements sont prêts",
      "button": {
        "text": "Télécharger"
      }
    },
    "download_page": {
      "texts": {
        "thanks": "Merci pour votre commande",
        "button": null
      }
    }
  },
  "untranslated": []
}

{
  "errors": [
    "Invalid API key"
  ]
}

{
  "errors": [
    "This product already has a digital product"
  ]
}

{
  "errors": [
    "access.download_limit_count must be an integer of at least 0"
  ],
  "field_errors": {
    "access.download_limit_count": [
      "must be an integer of at least 0"
    ]
  }
}

{
  "errors": [
    "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
  ],
  "code": "rate_limited",
  "retry_after": 12,
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}