---
updatedAt: 2025-07-22T09:06:45.000Z
agentTools:
  projectIndex: https://pt-developers.kommo.com/llms.txt
---

# Vinculando entidades

Este método permite vincular entidades a um negócio, contato ou empresa.

**Limitações**\
O método está disponível de acordo com os direitos do usuário.

**Cabeçalho de tipo de dado quando a solicitação é bem-sucedida**\
Content-Type: application/hal+json

**Cabeçalho de tipo de dado em caso de erro**\
Content-Type: application/problem+json

## Parâmetros de resposta

| Parâmetro                | Tipo de dado | Descrição                                                                     |
| :----------------------- | :----------- | :---------------------------------------------------------------------------- |
| to\_entity\_id           | int          | ID da entidade vinculada                                                      |
| to\_entity\_type         | string       | Tipos de entidades vinculadas (leads, contacts, companies, catalog\_elements) |
| metadata                 | object\|null | Metadados da entidade vinculada                                               |
| metadata\[main\_contact] | bool         | Define se o contato é principal para a entidade                               |
| metadata\[quantity]      | int          | Quantidade de elementos da lista vinculados                                   |
| metadata\[catalog\_id]   | int          | ID da lista                                                                   |
| metadata\[updated\_by]   | int          | ID do usuário que está realizando o vínculo                                   |

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "referencias-de-api-da-kommo",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://{subdomain}.kommo.com",
      "variables": {
        "subdomain": {
          "default": "subdomain"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/v4/{entity}/{entity_id}/link": {
      "post": {
        "summary": "Vinculando entidades",
        "description": "Este método permite vincular entidades a um negócio, contato ou empresa.",
        "operationId": "vinculando-entidades",
        "parameters": [
          {
            "name": "entity",
            "in": "path",
            "description": "Tipo de entidade",
            "schema": {
              "type": "string",
              "enum": [
                "leads",
                "contacts",
                "companies"
              ]
            },
            "required": true
          },
          {
            "name": "entity_id",
            "in": "path",
            "description": "ID da entidade",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          },
          {
            "name": "Content-Type",
            "in": "header",
            "description": "Cabeçalho da solicitação",
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "RAW_BODY": {
                    "type": "array",
                    "items": {
                      "properties": {
                        "to_entity_id": {
                          "type": "integer",
                          "description": "ID da entidade vinculada",
                          "format": "int32"
                        },
                        "to_entity_type": {
                          "type": "string",
                          "description": "Tipo de entidade vinculada (leads, contacts, companies, catalog_elements)",
                          "enum": [
                            "leads",
                            "contacts",
                            "companies",
                            "catalog_elements"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "description": "Metadados da entidade vinculada",
                          "properties": {
                            "catalog_id": {
                              "type": "integer",
                              "description": "ID da lista",
                              "format": "int32"
                            },
                            "quantity": {
                              "type": "integer",
                              "description": "Quantidade de elementos da lista vinculados",
                              "format": "int32"
                            },
                            "is_main": {
                              "type": "boolean",
                              "description": "Define se o contato é principal para a entidade"
                            },
                            "updated_by": {
                              "type": "integer",
                              "description": "ID do usuário que está realizando o vínculo",
                              "format": "int32"
                            }
                          }
                        }
                      },
                      "required": [
                        "to_entity_id",
                        "to_entity_type"
                      ],
                      "type": "object"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Entidades vinculadas com sucesso": {
                    "value": "{\n    \"_total_items\": 2,\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://example.kommo.com/api/v4/leads/XXXXXXX/links\"\n        }\n    },\n    \"_embedded\": {\n        \"links\": [\n            {\n                \"entity_id\": XXXXXXX,\n                \"entity_type\": \"leads\",\n                \"to_entity_id\": 10,\n                \"to_entity_type\": \"catalog_elements\",\n                \"metadata\": {\n                    \"quantity\": 1,\n                    \"catalog_id\": XXXX\n                }\n            },\n            {\n                \"entity_id\": XXXXXXX,\n                \"entity_type\": \"leads\",\n                \"to_entity_id\": XXXXX,\n                \"to_entity_type\": \"contacts\",\n                \"metadata\": {\n                    \"main_contact\": true\n                }\n            }\n        ]\n    }\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Dados inválidos fornecidos. Detalhes estão disponíveis na resposta da solicitação.": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Usuário não autorizado": {
                    "value": "{\n  \"title\": \"Unauthorized\",\n  \"type\": \"https://httpstatus.es/401\",\n  \"status\": 401,\n  \"detail\": \"Nome de usuário ou senha inválidos\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string",
                      "example": "Unauthorized"
                    },
                    "type": {
                      "type": "string",
                      "example": "https://httpstatus.es/401"
                    },
                    "status": {
                      "type": "integer",
                      "example": 401,
                      "default": 0
                    },
                    "detail": {
                      "type": "string",
                      "example": "Nome de usuário ou senha inválidos"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Direitos insuficientes para chamar este método.": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```