> ## Documentation Index
> Fetch the complete documentation index at: https://docs.evolutionfoundation.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Request password reset

> Request password reset instructions via email



## OpenAPI

````yaml /api-reference/openapi/Evo-Auth-Service/authentication.yaml post /api/v1/auth/forgot_password
openapi: 3.0.1
info:
  title: Evolution Foundation - Auth Service - Authentication
  description: Authentication and user and account management
  version: v1.0.0
servers:
  - url: https://api.evoai.app
    description: Production server
  - url: http://localhost:3001
    description: Development server
    variables:
      port:
        default: '3001'
  - url: '{customUrl}'
    description: Custom server
    variables:
      customUrl:
        default: https://your-instance.com
        description: Enter your server URL
security: []
paths:
  /api/v1/auth/forgot_password:
    post:
      summary: Request password reset
      description: Request password reset instructions via email
      operationId: forgotPassword
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                redirect_url:
                  type: string
                config_name:
                  type: string
              required:
                - email
      responses:
        '200':
          description: Password reset email sent
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                        format: date-time
                  message:
                    type: string
              examples:
                success:
                  summary: Successful response
                  value:
                    success: true
                    data:
                      success: true
                    meta:
                      timestamp: '2026-02-04T16:26:17Z'
                    message: Password reset instructions have been sent to your email
        '400':
          description: Bad Request (invalid data)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                bad_request:
                  summary: Invalid request format
                  value:
                    success: false
                    error:
                      code: VALIDATION_ERROR
                      message: Invalid request format
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/auth/forgot_password
                      method: POST
        '422':
          description: Unprocessable Entity (validation errors)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                email_required:
                  summary: Email is required
                  value:
                    success: false
                    error:
                      code: VALIDATION_ERROR
                      message: Email is required
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/auth/forgot_password
                      method: POST
                operation_failed:
                  summary: Failed to process password reset request
                  value:
                    success: false
                    error:
                      code: OPERATION_FAILED
                      message: Failed to process password reset request
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/auth/forgot_password
                      method: POST
        '500':
          description: Internal Server Error (erro interno do servidor)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                internal_error:
                  summary: Internal server error
                  value:
                    success: false
                    error:
                      code: INTERNAL_ERROR
                      message: An unexpected error occurred
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/auth/forgot_password
                      method: POST
        '503':
          description: Service Unavailable (erro no envio de email)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                email_delivery_failed:
                  summary: Unable to send password reset email
                  value:
                    success: false
                    error:
                      code: EMAIL_DELIVERY_FAILED
                      message: >-
                        Unable to send password reset email. Please contact
                        support or try again later.
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/auth/forgot_password
                      method: POST
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - success
        - error
        - meta
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Validation failed
            details:
              type: object
              additionalProperties: true
              nullable: true
        meta:
          type: object
          required:
            - timestamp
            - path
            - method
          properties:
            timestamp:
              type: string
              format: date-time
              example: '2024-01-15T10:30:00Z'
            path:
              type: string
              example: /api/v1/super_admin/accounts/123
            method:
              type: string
              example: POST

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.