> ## 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 Rank On Sale Document

> Set rank order on project document

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ListAgent.json post /api/v1/Agents/List/SetRankOnSaleDocument
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ListAgent
  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/List/SetRankOnSaleDocument:
    post:
      tags:
        - List_Agent
      summary: Set Rank On Sale Document
      description: |-
        Set rank order on project document

        NsApiSlow threshold: 5000 ms.
      operationId: v1ListAgent_SetRankOnSaleDocument
      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.ListCarriers.SetRankOnSaleDocumentRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SetRankOnSaleDocumentRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SetRankOnSaleDocumentRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SetRankOnSaleDocumentRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SetRankOnSaleDocumentRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SetRankOnSaleDocumentRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SetRankOnSaleDocumentRequest
        description: SaleTypeStageLinkId, ItemsIds
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.ListCarriers.SetRankOnSaleDocumentRequest:
      description: 'SetRankOnSaleDocument: Set rank order on project document'
      type: object
      properties:
        SaleTypeStageLinkId:
          format: int32
          type: integer
        ItemsIds:
          type: array
          items:
            format: int32
            type: integer

````

## Related topics

- [SuperOffice.WebApi.Data.List SetRankOnSaleDocumentRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_SetRankOnSaleDocumentRequest.md)
- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)
- [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)
- [Set Rank On Project Document](/en/api/reference/restful/agent/list_agent/set-rank-on-project-document.md)
- [Set Rank On Sale Activity](/en/api/reference/restful/agent/list_agent/set-rank-on-sale-activity.md)