> ## 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 Activity Filter

> Set activity filter for the specified list.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ArchiveAgent.json post /api/v1/Agents/Archive/SetActivityFilter
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ArchiveAgent
  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/Archive/SetActivityFilter:
    post:
      tags:
        - Archive_Agent
      summary: Set Activity Filter
      description: |-
        Set activity filter for the specified list.

        NsApiSlow threshold: 5000 ms.
      operationId: v1ArchiveAgent_SetActivityFilter
      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.ArchiveCarriers.SetActivityFilterRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.SetActivityFilterRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.SetActivityFilterRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.SetActivityFilterRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.SetActivityFilterRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.SetActivityFilterRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.SetActivityFilterRequest
        description: ActivityFilter
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.SetActivityFilterRequest:
      description: 'SetActivityFilter: Set activity filter for the specified list.'
      type: object
      properties:
        ActivityFilter:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.ActivityFilter'
    SuperOffice.CRM.Services.ActivityFilter:
      description: "Activity list filter information.\r\n<para />\r\nCarrier object for ActivityFilter.\r\nServices for the ActivityFilter Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IArchiveAgent\">Archive Agent</see>."
      type: object
      properties:
        FromDate:
          format: date-time
          description: The filtering From date
          type: string
        ToDate:
          format: date-time
          description: The filtering To date
          type: string
        AssociateList:
          description: The list of associates to filter on
          type: array
          items:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.SelectableMDOListItem
        GroupList:
          description: The list of groups to filter on
          type: array
          items:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.SelectableMDOListItem
        FutureDateList:
          description: >-
            The list of future date selections. This is a static MDO list with
            standard values.
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem'
        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.Services.SelectableMDOListItem:
      description: "Carrier object for SelectableMDOListItem.\r\nServices for the SelectableMDOListItem Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMDOAgent\">MDO Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The Id of the ListItem
          type: integer
        Name:
          description: The name of the ListItem
          type: string
        ToolTip:
          description: The tooltip of the ListItem
          type: string
        Deleted:
          description: The deleted status of the ListItem
          type: boolean
        Rank:
          format: int32
          description: The rank of the ListItem
          type: integer
        Type:
          description: The type of the ListItem. Custom field.
          type: string
        ColorBlock:
          format: int32
          description: The color indicator of the ListItem color block
          type: integer
        IconHint:
          description: The Icon hint of the ListItem. Custom field.
          type: string
        Selected:
          description: True if the ListItem is selected
          type: boolean
        LastChanged:
          format: date-time
          description: Time of last change.
          type: string
        ChildItems:
          description: The child items of the SelectableMDOListItem
          type: array
          items:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.SelectableMDOListItem
        ExtraInfo:
          description: >-
            Extra information added to the ListItem. Could be information such
            as sort order etc or other meta data. Custom field.
          type: string
        StyleHint:
          description: >-
            Style hint indicating, information such as background color etc.
            Custom field.
          type: string
        Hidden:
          description: True if the ListItem is hidden
          type: boolean
        FullName:
          description: The name of the ListItem in its context
          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.Services.MDOListItem:
      description: "Carrier object for MDOListItem.\r\nServices for the MDOListItem Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMDOAgent\">MDO Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The Id of the ListItem
          type: integer
        Name:
          description: The name of the ListItem
          type: string
        ToolTip:
          description: The tooltip of the ListItem
          type: string
        Deleted:
          description: The deleted status of the ListItem
          type: boolean
        Rank:
          format: int32
          description: The rank of the ListItem
          type: integer
        Type:
          description: The type of the ListItem. Custom field.
          type: string
        ChildItems:
          description: The child items of the MDOListItem
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem'
        IconHint:
          description: The Icon hint of the ListItem. Custom field.
          type: string
        ColorBlock:
          format: int32
          description: The color indicator of the ListItem color block
          type: integer
        ExtraInfo:
          description: >-
            Extra information added to the ListItem. Could be information such
            as sort order etc or other meta data. Custom field.
          type: string
        StyleHint:
          description: >-
            Style hint indicating, information such as background color etc.
            Custom field.
          type: string
        FullName:
          description: The name of the ListItem in its context
          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

- [SuperOffice.WebApi.Data.Archive SetActivityFilterRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Archive_SetActivityFilterRequest.md)
- [NSArchiveAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSArchiveAgent.md)
- [SuperOffice.WebApi.Agents.ArchiveAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ArchiveAgent.md)
- [SuperOffice.WebApi.Agents.IArchiveAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IArchiveAgent.md)
- [iarchiveagent](/en/api/search/iarchiveagent/iarchiveagent.md)
- [NSActivityFilter](/en/automation/crmscript/reference/CRMScript.NetServer.NSActivityFilter.md)