---
updatedAt: 2025-12-08T20:08:02.000Z
agentTools:
  projectIndex: https://docs.wink.cloud/llms.txt
---

# Reset password

Resets the user's password using a valid reset token.

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "WinkPG",
    "version": "v1"
  },
  "paths": {
    "/api/account/reset-password": {
      "post": {
        "tags": [
          "Account"
        ],
        "summary": "Reset password",
        "description": "Resets the user's password using a valid reset token.",
        "parameters": [
          {
            "name": "suppressNulls",
            "in": "query",
            "description": "If true, omit properties with null values.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WinkPGAccountResetPasswordDto"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/WinkPGAccountResetPasswordDto"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/WinkPGAccountResetPasswordDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              }
            }
          },
          "501": {
            "description": "Not Implemented",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "WinkPGAccountResetPasswordDto": {
        "required": [
          "password",
          "resetToken"
        ],
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "description": "",
            "format": "uuid"
          },
          "resetToken": {
            "minLength": 1,
            "type": "string",
            "description": ""
          },
          "password": {
            "minLength": 1,
            "type": "string",
            "description": ""
          }
        },
        "additionalProperties": false
      },
      "WinkPGHttpRemoteServiceErrorInfo": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "message": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "details": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "data": {
            "type": "object",
            "additionalProperties": {},
            "description": "",
            "nullable": true
          },
          "validationErrors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WinkPGHttpRemoteServiceValidationErrorInfo"
            },
            "description": "",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "WinkPGHttpRemoteServiceErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "$ref": "#/components/schemas/WinkPGHttpRemoteServiceErrorInfo"
          }
        },
        "additionalProperties": false
      },
      "WinkPGHttpRemoteServiceValidationErrorInfo": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "",
            "nullable": true
          },
          "members": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "description": "API key needed to access the endpoints",
        "name": "api-key",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "ApiKey": []
    }
  ],
  "servers": [
    {
      "url": "https://sandbox.winkpg.io"
    }
  ],
  "x-readme": {}
}
```