---
agentTools:
  projectIndex: https://kentro.readme.io/llms.txt
---

# request password reset

# OpenAPI definition

```json
{
  "servers": [
    {
      "url": "https://api.kentro.dev",
      "description": "Sandbox"
    },
    {
      "url": "https://api.kentro.live",
      "description": "Production"
    }
  ],
  "info": {
    "title": "Store API",
    "version": "1.149.3",
    "description": "Unlock the power of custom B2B storefronts. Manage and build your B2B store with comprehensive access to relevant features and functionalities through the Store-API.",
    "termsOfService": "https://kentro.io/terms-and-conditions",
    "contact": {
      "name": "support",
      "url": "https://kentro.io/contact-us",
      "email": "support@kentro.io"
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "x-proxy-enabled": true,
    "proxy-enabled": true
  },
  "paths": {
    "/v1/store/password/reset": {
      "post": {
        "parameters": [
          {
            "description": "Use only on sandbox to simulate request origin, on production it will default to \"Host\" header",
            "in": "header",
            "name": "X-Host-Override",
            "required": false,
            "schema": {
              "type": "string",
              "default": "store-domain.com"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1_store_password_reset_createResponse"
                }
              }
            }
          },
          "401": {
            "description": "Request is not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "The error name"
                    },
                    "message": {
                      "type": "string",
                      "description": "The error message"
                    },
                    "code": {
                      "type": "number",
                      "description": "An HTTP error code"
                    },
                    "className": {
                      "type": "string",
                      "description": "The full name of the error class"
                    },
                    "data": {
                      "type": "object",
                      "description": "Additional data to include in the error"
                    },
                    "errors": {
                      "type": "object",
                      "description": "Error object"
                    }
                  },
                  "required": [
                    "name",
                    "message",
                    "code",
                    "className",
                    "data",
                    "errors"
                  ],
                  "example": {
                    "name": "NotAuthenticated",
                    "message": "error message",
                    "code": 401,
                    "className": "not-authenticated",
                    "data": {
                      "key": "value"
                    },
                    "errors": {
                      "key": "value"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Request is forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "The error name"
                    },
                    "message": {
                      "type": "string",
                      "description": "The error message"
                    },
                    "code": {
                      "type": "number",
                      "description": "An HTTP error code"
                    },
                    "className": {
                      "type": "string",
                      "description": "The full name of the error class"
                    },
                    "data": {
                      "type": "object",
                      "description": "Additional data to include in the error"
                    },
                    "errors": {
                      "type": "object",
                      "description": "Error object"
                    }
                  },
                  "required": [
                    "name",
                    "message",
                    "code",
                    "className",
                    "data",
                    "errors"
                  ],
                  "example": {
                    "name": "Forbidden",
                    "message": "error message",
                    "code": 403,
                    "className": "forbidden",
                    "data": {
                      "key": "value"
                    },
                    "errors": {
                      "key": "value"
                    }
                  }
                }
              }
            }
          },
          "405": {
            "description": "Request method is not allowed on this endpoint",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "The error name"
                    },
                    "message": {
                      "type": "string",
                      "description": "The error message"
                    },
                    "code": {
                      "type": "number",
                      "description": "An HTTP error code"
                    },
                    "className": {
                      "type": "string",
                      "description": "The full name of the error class"
                    },
                    "data": {
                      "type": "object",
                      "description": "Additional data to include in the error"
                    },
                    "errors": {
                      "type": "object",
                      "description": "Error object"
                    }
                  },
                  "required": [
                    "name",
                    "message",
                    "code",
                    "className",
                    "data",
                    "errors"
                  ],
                  "example": {
                    "name": "MethodNotAllowed",
                    "message": "error message",
                    "code": 405,
                    "className": "method-not-allowed",
                    "data": {
                      "key": "value"
                    },
                    "errors": {
                      "key": "value"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Request is unprocessable",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "The error name"
                    },
                    "message": {
                      "type": "string",
                      "description": "The error message"
                    },
                    "code": {
                      "type": "number",
                      "description": "An HTTP error code"
                    },
                    "className": {
                      "type": "string",
                      "description": "The full name of the error class"
                    },
                    "data": {
                      "type": "object",
                      "description": "Additional data to include in the error"
                    },
                    "errors": {
                      "type": "object",
                      "description": "Error object"
                    }
                  },
                  "required": [
                    "name",
                    "message",
                    "code",
                    "className",
                    "data",
                    "errors"
                  ],
                  "example": {
                    "name": "Unprocessable",
                    "message": "error message",
                    "code": 422,
                    "className": "unprocessable",
                    "data": {
                      "key": "value"
                    },
                    "errors": {
                      "key": "value"
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "request password reset",
        "tags": [
          "password"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/v1_store_password_reset_createRequest"
              }
            }
          }
        },
        "x-code-samples": [
          {
            "lang": "Node + Request",
            "source": "const request = require('request');\n\nconst options = {\n  method: 'POST',\n  url: 'https://api.kentro.dev/v1/store/password/reset',\n  headers: {'content-type': 'application/json', 'X-Host-Override': 'SOME_STRING_VALUE'},\n  body: {email: 'example@email.com', phone: 'string'},\n  json: true\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
          },
          {
            "lang": "Python + Python3",
            "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.kentro.dev\")\n\npayload = \"{\\\"email\\\":\\\"example@email.com\\\",\\\"phone\\\":\\\"string\\\"}\"\n\nheaders = {\n    'content-type': \"application/json\",\n    'X-Host-Override': \"SOME_STRING_VALUE\"\n    }\n\nconn.request(\"POST\", \"/v1/store/password/reset\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
          },
          {
            "lang": "Ruby + Native",
            "source": "require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.kentro.dev/v1/store/password/reset\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"X-Host-Override\"] = 'SOME_STRING_VALUE'\nrequest.body = \"{\\\"email\\\":\\\"example@email.com\\\",\\\"phone\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "v1_store_password_reset_createRequest": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email"
          },
          "phone": {
            "type": "string",
            "format": "phone",
            "description": "Required if email is not provided"
          }
        },
        "example": {
          "email": "example@email.com",
          "phone": "string"
        }
      },
      "v1_store_password_reset_createResponse": {
        "type": "object",
        "properties": {
          "result": {
            "type": "boolean"
          },
          "error": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "errorCode": {
            "type": "string"
          }
        },
        "required": [
          "result"
        ],
        "example": {
          "result": false,
          "error": "string",
          "message": "string",
          "errors": [],
          "errorCode": "string"
        }
      }
    }
  },
  "openapi": "3.0.2",
  "_id": {
    "buffer": {
      "0": 98,
      "1": 224,
      "2": 139,
      "3": 140,
      "4": 55,
      "5": 7,
      "6": 59,
      "7": 0,
      "8": 73,
      "9": 14,
      "10": 54,
      "11": 136
    }
  }
}
```