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

# Send Account Recovery Email

> Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery email template ID is provided, an email using the custom email template will be used.

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| EmailRecipientBlacklisted | 1427 |
| InvalidEmailAddress | 1005 |
| NoContactEmailAddressFound | 1325 |
| SmtpAddonNotEnabled | 1341 |




## OpenAPI

````yaml post /Client/SendAccountRecoveryEmail
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Client API
  description: >-
    APIs which provide the full range of PlayFab features available to the
    client - authentication, account and data management, inventory, friends,
    matchmaking, reporting, and platform-specific functionality
  termsOfService: https://playfab.com/terms/
  contact:
    url: https://community.playfab.com/index.html
  license:
    name: Apache 2.0
    url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE
servers:
  - url: https://{titleId}.playfabapi.com
    description: PlayFab title endpoint
    variables:
      titleId:
        default: your_title_id
        description: Your PlayFab title ID (hex).
security: []
tags:
  - name: Account Management
    description: Account Management APIs
  - name: Advertising
    description: Advertising APIs
  - name: Analytics
    description: Analytics APIs
  - name: Authentication
    description: Authentication APIs
  - name: Character Data
    description: Character Data APIs
  - name: Characters
    description: Characters APIs
  - name: Content
    description: Content Service APIs
  - name: Friend List Management
    description: Friend List Management APIs
  - name: Matchmaking
    description: Matchmaking APIs
  - name: Platform Specific Methods
    description: Platform Specific Methods APIs
  - name: Player Data Management
    description: Player Data Management APIs
  - name: Player Item Management
    description: Player Item Management APIs
  - name: PlayStream
    description: PlayStream Management APIs
  - name: Server-Side Cloud Script
    description: Server-Side Cloud Script APIs
  - name: Shared Group Data
    description: Shared Group Data APIs
  - name: Title-Wide Data Management
    description: Title-Wide Data Management APIs
  - name: Trading
    description: Trading Management APIs
paths:
  /Client/SendAccountRecoveryEmail:
    post:
      tags:
        - Account Management
      summary: Send Account Recovery Email
      description: >
        Forces an email to be sent to the registered email address for the
        user's account, with a link allowing the user to change the password.If
        an account recovery email template ID is provided, an email using the
        custom email template will be used.


        ## Error codes


        This operation may return the following PlayFab errors:


        | Error | Code |

        | --- | --- |

        | EmailRecipientBlacklisted | 1427 |

        | InvalidEmailAddress | 1005 |

        | NoContactEmailAddressFound | 1325 |

        | SmtpAddonNotEnabled | 1341 |
      operationId: SendAccountRecoveryEmail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendAccountRecoveryEmailRequest'
        description: >-
          If the account in question is a "temporary" account (for example, one
          that was created via a call to LoginFromIOSDeviceID), thisfunction
          will have no effect. Only PlayFab accounts which have valid email
          addresses will be able to receive a password reset email using this
          API.
      responses:
        '200':
          $ref: '#/components/responses/SendAccountRecoveryEmailResult'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security: []
components:
  schemas:
    SendAccountRecoveryEmailRequest:
      description: >-
        If the account in question is a "temporary" account (for example, one
        that was created via a call to LoginFromIOSDeviceID), thisfunction will
        have no effect. Only PlayFab accounts which have valid email addresses
        will be able to receive a password reset email using this API.
      type: object
      properties:
        CustomTags:
          description: >-
            The optional custom tags associated with the request (e.g. build
            number, external trace identifiers, etc.).
          type: object
        Email:
          description: User email address attached to their account
          type: string
        EmailTemplateId:
          description: >-
            The email template id of the account recovery email template to
            send.
          type: string
        TitleId:
          description: >-
            Unique identifier for the title, found in the Settings > Game
            Properties section of the PlayFab developer site when a title has
            been selected.
          type: string
      required:
        - Email
        - TitleId
      example:
        Email: Me@here.com
        TitleId: '1000'
        EmailTemplateId: D53AB15D8F12E330
    SendAccountRecoveryEmailResult:
      type: object
      properties: {}
    ApiErrorWrapper:
      description: The basic wrapper around every failed API response
      type: object
      properties:
        code:
          description: Numerical HTTP code
          type: integer
        status:
          description: String HTTP code
          type: string
        error:
          description: Playfab error code
          type: string
        errorCode:
          description: Numerical PlayFab error code
          type: integer
        errorMessage:
          description: Description for the PlayFab errorCode
          type: string
        errorDetails:
          description: Detailed description of individual issues with the request object
          type: object
      required:
        - code
        - errorCode
  responses:
    SendAccountRecoveryEmailResult:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
                description: >-
                  The Http status code. If X-ReportErrorAsSuccess header is set
                  to true, this will report the actual http error code.
              status:
                type: string
                description: The Http status code as a string.
              data:
                $ref: '#/components/schemas/SendAccountRecoveryEmailResult'
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'

````

## Related topics

- [Send Account Recovery Email](/services/playfab/api-references/rest/admin/account-management/send-account-recovery-email.md)
- [PFAccountManagementSendAccountRecoveryEmailRequest](/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementsendaccountrecoveryemailrequest.md)
- [PFAccountManagementClientSendAccountRecoveryEmailAsync](/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementclientsendaccountrecoveryemailasync.md)
- [Email messaging quickstart](/services/playfab/live-service-management/game-configuration/title-communications/emails/quickstart.md)
- [PlayFab Release Notes 2018](/services/playfab/release-notes/2018.md)
