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

# Send Change Password E Mail

> Send a change password email to this users registered address.

NsApiSlow threshold: 2000 ms.
<para />## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps.



## OpenAPI

````yaml /openapi/agent/openapi-v3-UserAgent.json post /api/v1/Agents/User/SendChangePasswordEMail
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - UserAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/User/SendChangePasswordEMail:
    post:
      tags:
        - User_Agent
      summary: Send Change Password E Mail
      description: "Send a change password email to this users registered address.\n\nNsApiSlow threshold: 2000 ms.\r\n<para />## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps."
      operationId: v1UserAgent_SendChangePasswordEMail
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SendChangePasswordEMailRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SendChangePasswordEMailRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SendChangePasswordEMailRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SendChangePasswordEMailRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SendChangePasswordEMailRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SendChangePasswordEMailRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.SendChangePasswordEMailRequest
        description: AssociateId
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.OperationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.OperationResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.OperationResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.OperationResult'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.OperationResult'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.OperationResult'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.UserCarriers.SendChangePasswordEMailRequest:
      description: >-
        SendChangePasswordEMail: Send a change password email to this users
        registered address.
      type: object
      properties:
        AssociateId:
          format: int32
          type: integer
    SuperOffice.CRM.Services.OperationResult:
      description: "Operation result\r\n<para />\r\nCarrier object for OperationResult."
      type: object
      properties:
        Success:
          description: Indicates if the operation was successful.
          type: boolean
        Message:
          description: Success/Error message. This can be a symbol ([SR_xxxx])
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.User SendChangePasswordEMailRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_SendChangePasswordEMailRequest.md)
- [SuperOffice.WebApi.Agents.IUserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IUserAgent.md)
- [SuperOffice.WebApi.Agents.UserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.UserAgent.md)
- [OAuth 2.0 with Microsoft 365](/en/online/mail-services/curl/oauth-microsoft365.md)
- [Send passwords to contacts](/en/customer-center/learn/send-credentials.md)
- [Change Password](/en/api/reference/restful/agent/user_agent/change-password.md)