---
updatedAt: 2026-06-29T14:40:51.000Z
agentTools:
  projectIndex: https://developers.kommo.com/llms.txt
---

# Pin note

**Limitations**\
The method is available to all account users and depends on the user's permissions for the specific entity.

**Data type header when the request is successful**\
Content-Type: application/json

## Response parameters

The method does not return a response upon a successful request.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "kommo-api-references",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://{subdomain}.kommo.com",
      "variables": {
        "subdomain": {
          "default": "subdomain"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/v4/{entity_type}/notes/{id}/pin": {
      "post": {
        "description": "",
        "responses": {
          "204": {
            "description": "The note has been successfully pinned",
            "content": {
              "text/html": {
                "schema": {
                  "type": "object",
                  "properties": {}
                },
                "examples": {
                  "The note has been successfully pinned": {
                    "summary": "The note has been successfully pinned",
                    "value": "No content"
                  }
                }
              }
            }
          },
          "401": {
            "description": "The user is not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {}
                },
                "examples": {
                  "The user is not authorized": {
                    "summary": "The user is not authorized",
                    "value": {
                      "title": "Unauthorized",
                      "type": "https://httpstatus.es/401",
                      "status": 401,
                      "detail": "Invalid user name or password"
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "The account is not paid",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "name"
                  ]
                },
                "examples": {
                  "The account is not paid": {
                    "summary": "The account is not paid",
                    "value": {
                      "title": "Payment Required",
                      "type": "https://httpstatus.es/402",
                      "status": 402,
                      "detail": "Payment required"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "No enough rights to call this method",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {}
                },
                "examples": {
                  "No enough rights to call this method": {
                    "summary": "No enough rights to call this method",
                    "value": {
                      "title": "Forbidden",
                      "type": "https://httpstatus.es/403",
                      "status": 403,
                      "detail": "Access denied"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Note is not found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {}
                },
                "examples": {
                  "Note is not found": {
                    "summary": "Note is not found",
                    "value": {
                      "title": "Not Found",
                      "type": "https://httpstatus.es/404",
                      "status": 404,
                      "detail": "Requested entity not found"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "entity_type",
            "schema": {
              "type": "string",
              "enum": [
                "leads",
                "contacts",
                "companies"
              ]
            },
            "required": true,
            "description": "Entity type: `leads`/`contacts`/`companies`"
          },
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "integer"
            },
            "required": true,
            "description": "ID of the note"
          }
        ],
        "operationId": "post_api-v4-entity-type-notes-id-pin",
        "summary": "Pin note"
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```