PATCH /v1/supported-languages/games/{gameId}/languages/{languageCode}/universe-display-info-automatic-translation-settings — openapi

Update the switch which controls if the UniverseDisplayInformation should be automatically translated.

Endpoint

Method: PATCH

Path: /v1/supported-languages/games/{gameId}/languages/{languageCode}/universe-display-info-automatic-translation-settings

Servers:

https://gameinternationalization.roblox.com

Parameters

Name	Location	Required	Description
gameId	path	true	The game id.
languageCode	path	true	The language code.

[
  {
    "in": "path",
    "name": "gameId",
    "description": "The game id.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "path",
    "name": "languageCode",
    "description": "The language code.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

Whether to enable automatic translation for universe display info.

{
  "content": {
    "application/json": {
      "schema": {
        "type": "boolean"
      }
    },
    "text/json": {
      "schema": {
        "type": "boolean"
      }
    }
  },
  "description": "Whether to enable automatic translation for universe display info.",
  "required": true
}

Responses

Status	Description
200	OK
400	14: Invalid game id 72: Automatic translation cannot be enabled for game.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 18: You do not have permission to manage this game
500	77: Content localization set settings return error code invalid 79: Invalid content instance settings 80: Invalid quota settings 81: Invalid change agent 82: Failed to update UniverseDisplayInformation content instance auto translation settings

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.GameInternationalization.Api.UpdateUniverseDisplayInfoAutomaticTranslationSettingsResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.GameInternationalization.Api.UpdateUniverseDisplayInfoAutomaticTranslationSettingsResponse"
        }
      }
    }
  },
  "400": {
    "description": "14: Invalid game id\r\n72: Automatic translation cannot be enabled for game."
  },
  "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"
  },
  "500": {
    "description": "77: Content localization set settings return error code invalid\r\n79: Invalid content instance settings\r\n80: Invalid quota settings\r\n81: Invalid change agent\r\n82: Failed to update UniverseDisplayInformation content instance auto translation settings"
  }
}

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.UpdateUniverseDisplayInfoAutomaticTranslationSettingsResponse

Complete Operation Definition

{
  "tags": [
    "Localization",
    "Universes"
  ],
  "summary": "Update the switch which controls if the UniverseDisplayInformation should be automatically translated.",
  "parameters": [
    {
      "in": "path",
      "name": "gameId",
      "description": "The game id.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "path",
      "name": "languageCode",
      "description": "The language code.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "boolean"
        }
      },
      "text/json": {
        "schema": {
          "type": "boolean"
        }
      }
    },
    "description": "Whether to enable automatic translation for universe display info.",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.GameInternationalization.Api.UpdateUniverseDisplayInfoAutomaticTranslationSettingsResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.GameInternationalization.Api.UpdateUniverseDisplayInfoAutomaticTranslationSettingsResponse"
          }
        }
      }
    },
    "400": {
      "description": "14: Invalid game id\r\n72: Automatic translation cannot be enabled for game."
    },
    "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"
    },
    "500": {
      "description": "77: Content localization set settings return error code invalid\r\n79: Invalid content instance settings\r\n80: Invalid quota settings\r\n81: Invalid change agent\r\n82: Failed to update UniverseDisplayInformation content instance auto translation settings"
    }
  },
  "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__universe_display_info_automatic_translation_settings"
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://apis.roblox.com/legacy-game-internationalization/v1/supported-languages/games/{gameId}/languages/{languageCode}/universe-display-info-automatic-translation-settings",
      "httpMethod": "PATCH",
      "documentationUrl": "https://create.roblox.com/docs/cloud/reference/features/localization#patch_legacy_game_internationalization_v1_supported_languages_games__gameId__languages__languageCode__universe_display_info_automatic_translation_settings"
    }
  ]
}