PATCH /v1/supported-languages/games/{gameId}/languages/{languageCode}/automatic-translation-status — openapi

Enable or disable automatic translation for a game and language.

Endpoint

Method: PATCH

Path: /v1/supported-languages/games/{gameId}/languages/{languageCode}/automatic-translation-status

Servers:

https://gameinternationalization.roblox.com

Parameters

Name	Location	Required	Description
gameId	path	true	The id of the game.
languageCode	path	true	The language to enable or disable for automatic translation.

[
  {
    "in": "path",
    "name": "gameId",
    "description": "The id of the game.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "path",
    "name": "languageCode",
    "description": "The language to enable or disable for automatic translation.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

Flag to indicate if automatic translation should be enabled or disabled.

{
  "content": {
    "application/json": {
      "schema": {
        "type": "boolean"
      }
    },
    "text/json": {
      "schema": {
        "type": "boolean"
      }
    }
  },
  "description": "Flag to indicate if automatic translation should be enabled or disabled.",
  "required": true
}

Responses

Status	Description
200	OK
400	14: Invalid game id 22: Invalid language code 53: Language is not supported for the game. 72: Automatic translation cannot be enabled for game. 75: Automatic translation cannot be enabled for language.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
503	17: Feature is disabled

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.GameInternationalization.Api.EditAutomaticTranslationStatusForGameAndLanguageResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.GameInternationalization.Api.EditAutomaticTranslationStatusForGameAndLanguageResponse"
        }
      }
    }
  },
  "400": {
    "description": "14: Invalid game id\r\n22: Invalid language code\r\n53: Language is not supported for the game.\r\n72: Automatic translation cannot be enabled for game.\r\n75: Automatic translation cannot be enabled for language."
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "0: Token Validation Failed\r\n18: You do not have permission to manage this game"
  },
  "503": {
    "description": "17: Feature is disabled"
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Roblox.GameInternationalization.Api.EditAutomaticTranslationStatusForGameAndLanguageResponse

Complete Operation Definition

{
  "tags": [
    "Localization",
    "Universes"
  ],
  "summary": "Enable or disable automatic translation for a game and language.",
  "parameters": [
    {
      "in": "path",
      "name": "gameId",
      "description": "The id of the game.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "path",
      "name": "languageCode",
      "description": "The language to enable or disable for automatic translation.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "boolean"
        }
      },
      "text/json": {
        "schema": {
          "type": "boolean"
        }
      }
    },
    "description": "Flag to indicate if automatic translation should be enabled or disabled.",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.GameInternationalization.Api.EditAutomaticTranslationStatusForGameAndLanguageResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.GameInternationalization.Api.EditAutomaticTranslationStatusForGameAndLanguageResponse"
          }
        }
      }
    },
    "400": {
      "description": "14: Invalid game id\r\n22: Invalid language code\r\n53: Language is not supported for the game.\r\n72: Automatic translation cannot be enabled for game.\r\n75: Automatic translation cannot be enabled for language."
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "0: Token Validation Failed\r\n18: You do not have permission to manage this game"
    },
    "503": {
      "description": "17: Feature is disabled"
    }
  },
  "servers": [
    {
      "url": "https://gameinternationalization.roblox.com"
    }
  ],
  "x-roblox-stability": "EXPERIMENTAL",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/localization#gameinternationalization_patch_v1_supported_languages_games__gameId__languages__languageCode__automatic_translation_status"
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://apis.roblox.com/legacy-game-internationalization/v1/supported-languages/games/{gameId}/languages/{languageCode}/automatic-translation-status",
      "httpMethod": "PATCH",
      "documentationUrl": "https://create.roblox.com/docs/cloud/reference/features/localization#patch_legacy_game_internationalization_v1_supported_languages_games__gameId__languages__languageCode__automatic_translation_status"
    }
  ]
}