POST /v2/passwords/reset/send — openapi

Sends a password reset email or challenge to the specified target.

Phone target must be a csv with 3 values: "internationalPrefixNumber,nationalNumber,countryCode"

Endpoint

Method: POST

Path: /v2/passwords/reset/send

Servers:

https://auth.roblox.com

Request Body

The request model containing the target type and a target.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.SendResetPasswordRequest"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.SendResetPasswordRequest"
      }
    }
  },
  "description": "The request model containing the target type and a target.",
  "required": true
}

Responses

Status	Description
200	OK
400	3: Request was empty. 9: The target type is invalid. 10: The target is invalid. 12: The user is invalid.
403	0: Token Validation Failed 18: Captcha is required. 23: Authenticate with Luobu instead.
429	2: Too many attempts. Please try again later.
500	0: Unknown error occured. 19: Message could not be sent.
503	1: Feature temporarily disabled. Please try again later.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.SendResetPasswordResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.SendResetPasswordResponse"
        }
      }
    }
  },
  "400": {
    "description": "3: Request was empty.\r\n9: The target type is invalid.\r\n10: The target is invalid.\r\n12: The user is invalid."
  },
  "403": {
    "description": "0: Token Validation Failed\r\n18: Captcha is required.\r\n23: Authenticate with Luobu instead."
  },
  "429": {
    "description": "2: Too many attempts. Please try again later."
  },
  "500": {
    "description": "0: Unknown error occured.\r\n19: Message could not be sent."
  },
  "503": {
    "description": "1: Feature temporarily 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"
  ],
  "summary": "Sends a password reset email or challenge to the specified target.",
  "description": "Phone target must be a csv with 3 values: \"internationalPrefixNumber,nationalNumber,countryCode\"",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.SendResetPasswordRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.SendResetPasswordRequest"
        }
      }
    },
    "description": "The request model containing the target type and a target.",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.SendResetPasswordResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.SendResetPasswordResponse"
          }
        }
      }
    },
    "400": {
      "description": "3: Request was empty.\r\n9: The target type is invalid.\r\n10: The target is invalid.\r\n12: The user is invalid."
    },
    "403": {
      "description": "0: Token Validation Failed\r\n18: Captcha is required.\r\n23: Authenticate with Luobu instead."
    },
    "429": {
      "description": "2: Too many attempts. Please try again later."
    },
    "500": {
      "description": "0: Unknown error occured.\r\n19: Message could not be sent."
    },
    "503": {
      "description": "1: Feature temporarily disabled. Please try again later."
    }
  },
  "servers": [
    {
      "url": "https://auth.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/accounts#auth_post_v2_passwords_reset_send"
  }
}