Create or update a translation

Stages a translation draft for a locale, creating the translation if it does not exist yet.

PUT /v1/articles/{id}/translations/{locale}

Bearer token scope content:write

curl 'https://api.ferndesk.com/v1/articles/art_01JXY9AZK4KV/translations/en' \
  --request PUT \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Débuter avec les clés API",
  "content": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Welcome to Ferndesk."
          }
        ]
      }
    ]
  },
  "markdown": "# Débuter\n\nBienvenue dans l’API.",
  "publish": false
}'

{
  "articleId": "art_01JXY9AZK4KV",
  "language": "fr",
  "draftId": "drft_01JXY9AZK4KV",
  "published": false
}

Staged/published translation

Path parameters

· 2

id string required

Identifier of the requested resource.

locale string · min length: 2· max length: 16 required

Locale code of the translation.

Body

required application/json

title string · min length: 1

Localized title.

content any

Localized body as a Tiptap document; not accepted alongside markdown.

markdown string

Localized body as Markdown; not accepted alongside content.

publish boolean · default: false

Publishes the translation in the same call instead of leaving it staged.

Path parameters

Body

Responses