> ## Documentation Index
> Fetch the complete documentation index at: https://developers.qshop.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Forgot Password

> **Host**: http://qshop.ng



## OpenAPI

````yaml post /auth/storefront/forgot-password
openapi: 3.1.0
info:
  title: OpenAPI Specification
  version: 1.0.0
  description: >-
    QShop storefront API.  This API is used to build a storefront for a QShop
    store
  contact:
    name: QShop
    url: https://qshop.ng
    email: hello@qshop.ng
servers:
  - url: http://staging.qshop.ng/apiv2
    description: Staging server
  - url: http://qshop.ng/api
    description: Production server
security: []
paths:
  /auth/storefront/forgot-password:
    post:
      tags:
        - Authentication
      summary: Forgot Password
      description: '**Host**: http://qshop.ng'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                shop:
                  type: string
              required:
                - email
                - shop
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      campaigns:
                        type: array
                      _id:
                        type: string
                      shop:
                        type: object
                        properties:
                          _id:
                            type: string
                          name:
                            type: string
                          email:
                            type: string
                          slug:
                            type: string
                          domainName:
                            type: string
                          logo_uuid:
                            type: string
                          domainActive:
                            type: boolean
                          url:
                            type: string
                        required:
                          - _id
                          - name
                          - email
                          - slug
                          - domainName
                          - logo_uuid
                          - domainActive
                          - url
                      user:
                        type: object
                        properties:
                          kyc:
                            type: object
                            properties:
                              status:
                                type: 'null'
                              attempts:
                                type: integer
                              errors:
                                type: array
                            required:
                              - status
                              - attempts
                              - errors
                          suspended:
                            type: boolean
                          isActivated:
                            type: boolean
                          isPseudoAccount:
                            type: boolean
                          _id:
                            type: string
                          roles:
                            type: array
                            items:
                              type: string
                          email:
                            type: string
                          username:
                            type: string
                          __v:
                            type: integer
                          full_name:
                            type: string
                          last_access:
                            type: string
                          reg_date:
                            type: string
                          shopCount:
                            type: integer
                          test_user:
                            type: boolean
                          telephone:
                            type: string
                          status:
                            type: string
                          addresses:
                            type: array
                        required:
                          - kyc
                          - suspended
                          - isActivated
                          - isPseudoAccount
                          - _id
                          - roles
                          - email
                          - username
                          - __v
                          - full_name
                          - last_access
                          - reg_date
                          - shopCount
                          - test_user
                          - telephone
                          - status
                          - addresses
                      __v:
                        type: integer
                      acceptanceToken:
                        type: 'null'
                      created_at:
                        type: string
                      email:
                        type: string
                      fullName:
                        type: string
                      isClaimed:
                        type: boolean
                      notes:
                        type: array
                      notifyViaWhatsApp:
                        type: boolean
                      numberOfOrders:
                        type: integer
                      orderTotal:
                        type: integer
                      password:
                        type: string
                      resetPassword:
                        type: boolean
                      roles:
                        type: array
                        items:
                          type: object
                          properties:
                            _id:
                              type: string
                            __v:
                              type: integer
                            isAdmin:
                              type: boolean
                            name:
                              type: string
                            isSuperAdmin:
                              type: boolean
                            key:
                              type: string
                            type:
                              type: string
                          required:
                            - _id
                            - __v
                            - isAdmin
                            - name
                            - isSuperAdmin
                            - key
                            - type
                      suspended:
                        type: boolean
                      suspendedRoles:
                        type: array
                      telephone:
                        type: string
                      updated_at:
                        type: string
                      whatsAppNumber:
                        type: string
                    required:
                      - campaigns
                      - _id
                      - shop
                      - user
                      - __v
                      - acceptanceToken
                      - created_at
                      - email
                      - fullName
                      - isClaimed
                      - notes
                      - notifyViaWhatsApp
                      - numberOfOrders
                      - orderTotal
                      - password
                      - resetPassword
                      - roles
                      - suspended
                      - suspendedRoles
                      - telephone
                      - updated_at
                      - whatsAppNumber
                  success:
                    type: boolean
                required:
                  - msg
                  - data
                  - success
          description: ''

````