Away 10:16 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.

PATCH /v1/users/{userId}/display-names — openapi

Set the display name for the authorized user.

Endpoint

Method: PATCH

Path: /v1/users/{userId}/display-names

Servers:

Parameters

NameLocationRequiredDescription
userIdpathtruethe user id
 
[
  {
    "in": "path",
    "name": "userId",
    "description": "the user id",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Request Body

Roblox.Users.Api.SetDisplayNameRequest

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

Responses

StatusDescription
200OK
4001: Display name is too short 2: Display name is too long 3: Display name contains invalid characters 4: Display name has been moderated 8: Display name has too many combinations of character sets
4010: Authorization has been denied for this request.
4030: Token Validation Failed 7: The user id is invalid.
4295: Display name updates for this user have been throttled
 
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
        }
      }
    }
  },
  "400": {
    "description": "1: Display name is too short\r\n2: Display name is too long\r\n3: Display name contains invalid characters\r\n4: Display name has been moderated\r\n8: Display name has too many combinations of character sets"
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "0: Token Validation Failed\r\n7: The user id is invalid."
  },
  "429": {
    "description": "5: Display name updates for this user have been throttled"
  }
}

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": [
    "User profiles",
    "Users"
  ],
  "summary": "Set the display name for the authorized user.",
  "parameters": [
    {
      "in": "path",
      "name": "userId",
      "description": "the user id",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Users.Api.SetDisplayNameRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Users.Api.SetDisplayNameRequest"
        }
      }
    },
    "description": "Roblox.Users.Api.SetDisplayNameRequest",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
          }
        }
      }
    },
    "400": {
      "description": "1: Display name is too short\r\n2: Display name is too long\r\n3: Display name contains invalid characters\r\n4: Display name has been moderated\r\n8: Display name has too many combinations of character sets"
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "0: Token Validation Failed\r\n7: The user id is invalid."
    },
    "429": {
      "description": "5: Display name updates for this user have been throttled"
    }
  },
  "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/user-profiles#users_patch_v1_users__userId__display_names"
  }
}