> ## 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.

# Make Retired

> Retiring a user means to remove all licenses, setting person.

retired=1 and associate.deleted=1. Unretiering a user means setting  person.retired=0 and associate.deleted=0
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/MakeRetired
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/MakeRetired:
    post:
      tags:
        - User_Agent
      summary: Make Retired
      description: "Retiring a user means to remove all licenses, setting person.\n\nretired=1 and associate.deleted=1. Unretiering a user means setting  person.retired=0 and associate.deleted=0\r\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_MakeRetired
      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: 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.MakeRetiredRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.MakeRetiredRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.MakeRetiredRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.MakeRetiredRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.MakeRetiredRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.MakeRetiredRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.MakeRetiredRequest
        description: AssociateId, Retired
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.UserCarriers.MakeRetiredRequest:
      description: >-
        MakeRetired: Retiring a user means to remove all licenses, setting
        person.retired=1 and associate.deleted=1. Unretiering a user means
        setting  person.retired=0 and associate.deleted=0
      type: object
      properties:
        AssociateId:
          format: int32
          type: integer
        Retired:
          type: boolean

````

## Related topics

- [SuperOffice.WebApi.Data.User MakeRetiredRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_MakeRetiredRequest.md)
- [NSUserAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSUserAgent.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)
- [SuperOffice.WebApi.Data.Person](/en/api/reference/webapi/SuperOffice.WebApi.Data.Person.md)
- [contactperson_freetextsearch](/en/api/mdo-providers/reference/contactperson_freetextsearch.md)