Password Reset

This endpoint initiates the password set process.

{
  "Host": "api.bringyour.com",
  "Content-Type": "application/json"
}

Body:

{
  "reset_code": "string",
  "password": "string"
}

Response

200 Success

Status: 200 OK

Content-Type: application/json

{}

A successful response returns an empty object, indicating the password has been successfully updated.

Example

HTTP Request

POST /auth/password-set HTTP/1.1
Host: api.bringyour.com
Content-Type: application/json
 
{
  "reset_code": "RST-1234-5678",
  "password": "NewSecurePassword!"
}

Successful HTTP Response

{}

---
title: Password Set
short_name: Set Password
description: Set a new password for your account using a reset code.
---

# Password Set

This endpoint allows you to establish a new password for your account after initiating a password reset. You must provide the `reset_code` sent to your registered email or phone number.

---

## `POST /auth/password-set`

Submit a new password using a valid reset code.

### Request

`POST /auth/password-set`

**Headers:**

```json
{
  "Host": "api.bringyour.com",
  "Content-Type": "application/json"
}

Body:

{
  "reset_code": "string",
  "password": "string"
}

Response

200 Success

Status: 200 OK

Content-Type: application/json

{}

A successful response returns an empty object, indicating the password has been successfully updated.

Example

HTTP Request

POST /auth/password-set HTTP/1.1
Host: api.bringyour.com
Content-Type: application/json
 
{
  "reset_code": "RST-1234-5678",
  "password": "NewSecurePassword!"
}

Successful HTTP Response

{}