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

# Set Preferences

> Setting Phone List Preferences to the CRM 5 user preferences

NsApiSlow threshold: 1000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-PhoneListAgent.json post /api/v1/Agents/PhoneList/SetPreferences
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/SetPreferences:
    post:
      tags:
        - PhoneList_Agent
      summary: Set Preferences
      description: |-
        Setting Phone List Preferences to the CRM 5 user preferences

        NsApiSlow threshold: 1000 ms.
      operationId: v1PhoneListAgent_SetPreferences
      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.PhoneListCarriers.SetPreferencesRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.SetPreferencesRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.SetPreferencesRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.SetPreferencesRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.SetPreferencesRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.SetPreferencesRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.SetPreferencesRequest
        description: Preferences
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.PhoneListCarriers.SetPreferencesRequest:
      description: >-
        SetPreferences: Setting Phone List Preferences to the CRM 5 user
        preferences
      type: object
      properties:
        Preferences:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.PhoneListPreferences'
    SuperOffice.CRM.Services.PhoneListPreferences:
      description: "Search preferences for a phone list search\r\n<para />\r\nCarrier object for PhoneListPreferences.\r\nServices for the PhoneListPreferences Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IPhoneListAgent\">PhoneList Agent</see>."
      type: object
      properties:
        SearchCompany:
          description: True if you want to search for Companies by their name.
          type: boolean
        SearchFirstname:
          description: True if you want to search for Persons by their firstname.
          type: boolean
        SearchLastname:
          description: True if you want to search for Persons by their lastname.
          type: boolean
        SearchDepartment:
          description: >-
            True if you want to search for Departments where your colleagues
            work.
          type: boolean
        SearchModeCompany:
          description: >-
            The Company name search type, e.g. BeginsWith, Contains, Endswith,
            Matches
          enum:
            - Exact
            - BeginsWith
            - EndsWith
            - Contains
          type: string
        SearchModeDepartment:
          description: >-
            The Department search type, e.g. BeginsWith, Contains, Endswith,
            Matches
          enum:
            - Exact
            - BeginsWith
            - EndsWith
            - Contains
          type: string
        SearchModeFirstname:
          description: >-
            The firstname search type, e.g. BeginsWith, Contains, Endswith,
            Matches
          enum:
            - Exact
            - BeginsWith
            - EndsWith
            - Contains
          type: string
        SearchModeLastname:
          description: >-
            The lastname search type, e.g. BeginsWith, Contains, Endswith,
            Matches
          enum:
            - Exact
            - BeginsWith
            - EndsWith
            - Contains
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Set preference](/en/api/web-services/howto/user-preferences/set-preferences-preferenceagent.md)
- [Preferences](/en/admin/preferences/index.md)
- [User preferences](/en/admin/user-preferences/index.md)
- [NSPreference](/en/automation/crmscript/reference/CRMScript.NetServer.NSPreference.md)
- [Working with preferences](/en/admin/preferences/update.md)
- [Change a preference](/en/learn/getting-started/preferences.md)