Update a translation

put

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

translationIdstringRequired

The unique id of the translation

Body

application/json

Responses

200

Translation has been updated

application/json

objectstring · enumRequiredPossible values:

idstringRequired

Unique identifier of the translation sync

statusstring · enumRequiredPossible values:

languagestring · enumRequiredPossible values:

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

400

Bad Request

application/json

put/orgs/{organizationId}/translations/{translationId}

HTTPcURLJavaScriptPython

PUT /v1/orgs/{organizationId}/translations/{translationId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "instructions": {
    "object": "document",
    "data": {},
    "nodes": [
      {
        "object": "block",
        "type": "paragraph",
        "data": {},
        "nodes": [
          {
            "object": "text",
            "leaves": [
              {
                "object": "leaf",
                "text": "Hello world",
                "marks": []
              }
            ]
          }
        ]
      }
    ]
  }
}

{
  "object": "translation",
  "id": "text",
  "status": "pending",
  "source": {
    "space": "text",
    "language": "en"
  },
  "language": "en",
  "instructions": {
    "object": "document",
    "data": {},
    "nodes": [
      {
        "object": "block",
        "type": "paragraph",
        "data": {},
        "nodes": [
          {
            "object": "text",
            "leaves": [
              {
                "object": "leaf",
                "text": "Hello world",
                "marks": []
              }
            ]
          }
        ]
      }
    ]
  },
  "result": {
    "space": "text",
    "revision": "text",
    "language": "en"
  },
  "createdAt": "2026-07-21T20:50:46.678Z",
  "updatedAt": "2026-07-21T20:50:46.678Z",
  "stats": {
    "runs": 1,
    "totalWords": 1,
    "totalPages": 1,
    "totalDuration": 1,
    "latestRunDuration": 1,
    "latestPages": 1,
    "latestWords": 1
  },
  "permissions": {
    "view": true,
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}