Set a new password with a reset code

POST

/api/v1/public/password-reset/confirm

curl --request POST \
  --url https://api.deploybase.eu/api/v1/api/v1/public/password-reset/confirm \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example", "new_password": "example", "user_id": "69629026806489455" }'

Sets the password with the code from a reset link, then mails a “password changed” notice to the account’s address. No authentication required: the code is the authorisation. Limited to 10 per user and 30 per IP per hour.

Request Body

User id and code from the link, and the new password

Media type application/json

object

code

string

new_password

string

user_id

string

Example

69629026806489455

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

status

string

Example

{
  "data": {
    "status": "done"
  }
}

400

The code did not work (ACCOUNT_CODE_INVALID) or the password was refused (INVALID_INPUT, details.field=password)

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

details

object

reason

string

Allowed values: used expired invalid

Example

{
  "details": {
    "reason": "used"
  }
}

429

Too many attempts; see Retry-After

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

503

Temporarily unavailable

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}