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

# Add To Favorites

> Adds a new contact to the history/favorites.

Returns the rank of the new history item. If the contact already existed in the history, it isn't added but the rank is updated.
NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-PhoneListAgent.json post /api/v1/Agents/PhoneList/AddToFavorites
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - PhoneListAgent
  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/PhoneList/AddToFavorites:
    post:
      tags:
        - PhoneList_Agent
      summary: Add To Favorites
      description: "Adds a new contact to the history/favorites.\n\nReturns the rank of the new history item. If the contact already existed in the history, it isn't added but the rank is updated.\r\nNsApiSlow threshold: 2000 ms."
      operationId: v1PhoneListAgent_AddToFavorites
      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.PhoneListCarriers.AddToFavoritesRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.AddToFavoritesRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.AddToFavoritesRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.AddToFavoritesRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.AddToFavoritesRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.AddToFavoritesRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.AddToFavoritesRequest
        description: ContactId
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: int32
                type: integer
            text/json:
              schema:
                format: int32
                type: integer
            application/xml:
              schema:
                format: int32
                type: integer
            text/xml:
              schema:
                format: int32
                type: integer
            application/json-patch+json:
              schema:
                format: int32
                type: integer
            application/merge-patch+json:
              schema:
                format: int32
                type: integer
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.AddToFavoritesRequest:
      description: >-
        AddToFavorites: Adds a new contact to the history/favorites. Returns the
        rank of the new history item. If the contact already existed in the
        history, it isn't added but the rank is updated.
      type: object
      properties:
        ContactId:
          format: int32
          type: integer

````

## Related topics

- [Favorites in SuperOffice CRM](/en/learn/basics/fav.md)
- [SuperOffice.WebApi.Data.PhoneList AddToFavoritesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.PhoneList_AddToFavoritesRequest.md)
- [Interface guide](/en/mobile/interface-guide.md)
- [NSPhoneListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSPhoneListAgent.md)
- [SuperOffice.WebApi.Agents.PhoneListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.PhoneListAgent.md)
- [SuperOffice.WebApi.Agents.IPhoneListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IPhoneListAgent.md)