POST /v1/locales/set-user-supported-locale — openapi

Sets user's supported locale. Null supported locale will clear out user's supported locale (set users' supported locale to null)

Endpoint

Method: POST

Path: /v1/locales/set-user-supported-locale

Servers:

https://locale.roblox.com

Request Body

Supported locale code that needs to be set for user

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Locale.Api.SetSupportedLocaleForUserRequest"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Locale.Api.SetSupportedLocaleForUserRequest"
      }
    }
  },
  "description": "Supported locale code that needs to be set for user",
  "required": true
}

Responses

Status	Description
200	OK
400	Bad Request
401	Unauthorized 0: Authorization has been denied for this request.
403	Feature is turned off temporary 0: Token Validation Failed
500	Internal server error

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Locale.Api.SuccessResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Locale.Api.SuccessResponse"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request"
  },
  "401": {
    "description": "Unauthorized\r\n0: Authorization has been denied for this request."
  },
  "403": {
    "description": "Feature is turned off temporary\r\n0: Token Validation Failed"
  },
  "500": {
    "description": "Internal server error"
  }
}

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": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Localization",
    "Metadata"
  ],
  "summary": "Sets user's supported locale.\r\nNull supported locale will clear out user's supported locale (set users' supported locale to null)",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Locale.Api.SetSupportedLocaleForUserRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Locale.Api.SetSupportedLocaleForUserRequest"
        }
      }
    },
    "description": "Supported locale code that needs to be set for user",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Locale.Api.SuccessResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Locale.Api.SuccessResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request"
    },
    "401": {
      "description": "Unauthorized\r\n0: Authorization has been denied for this request."
    },
    "403": {
      "description": "Feature is turned off temporary\r\n0: Token Validation Failed"
    },
    "500": {
      "description": "Internal server error"
    }
  },
  "servers": [
    {
      "url": "https://locale.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/localization#locale_post_v1_locales_set_user_supported_locale"
  }
}