Initiate password reset

POST

/v1/auth/forgot-password

curl --request POST \
  --url https://kynectlocal-production.up.railway.app/v1/v1/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "tenantSlug": "example" }'

• Authenticated API (v1)
• Public API (no auth required)

Request Body ^required

Media type application/json

object

email

required

string format: email

tenantSlug

required

string

Example ^generated

{
  "email": "hello@example.com",
  "tenantSlug": "example"
}

Responses

200

Success

Media type application/json

object

data

required

object

ok

required

Indicates the operation succeeded

boolean

Example

{
  "data": {
    "ok": true
  }
}

400

Validation error

Media type application/json

object

error

required

Error envelope

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

details

Additional context, e.g. validation field errors

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

Error envelope

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

details

Additional context, e.g. validation field errors

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

Error envelope

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

details

Additional context, e.g. validation field errors

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media type application/json

object

error

required

Error envelope

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

details

Additional context, e.g. validation field errors

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Unprocessable

Media type application/json

object

error

required

Error envelope

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

details

Additional context, e.g. validation field errors

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}