Away 10:58 PM

3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

POST /v1/description#users.roblox.com — openapi

Update the user's description

Endpoint

Method: POST

Path: /v1/description#users.roblox.com

Servers:

Request Body

The Roblox.Users.Api.DescriptionRequest

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Users.Api.DescriptionRequest"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Users.Api.DescriptionRequest"
      }
    }
  },
  "description": "The Roblox.Users.Api.DescriptionRequest",
  "required": true
}

Responses

StatusDescription
200OK
4001: User not found.
4010: Authorization has been denied for this request.
4030: Token Validation Failed 2: PIN is locked.
5000: An unknown error occured.
5033: This feature is currently disabled. Please try again later.
 
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Users.Api.DescriptionResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Users.Api.DescriptionResponse"
        }
      }
    }
  },
  "400": {
    "description": "1: User not found."
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "0: Token Validation Failed\r\n2: PIN is locked."
  },
  "500": {
    "description": "0: An unknown error occured."
  },
  "503": {
    "description": "3: This feature is currently disabled. Please try again later."
  }
}

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": [
    "Accounts",
    "User profiles"
  ],
  "summary": "Update the user's description",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Users.Api.DescriptionRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Users.Api.DescriptionRequest"
        }
      }
    },
    "description": "The Roblox.Users.Api.DescriptionRequest",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Users.Api.DescriptionResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Users.Api.DescriptionResponse"
          }
        }
      }
    },
    "400": {
      "description": "1: User not found."
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "0: Token Validation Failed\r\n2: PIN is locked."
    },
    "500": {
      "description": "0: An unknown error occured."
    },
    "503": {
      "description": "3: This feature is currently disabled. Please try again later."
    }
  },
  "servers": [
    {
      "url": "https://users.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/accounts#users_post_v1_description"
  }
}