--- title: "Adicionando leads de entrada do tipo formulário" method: POST path: "/api/v4/leads/unsorted/forms" --- # Adicionando leads de entrada do tipo formulário `POST /api/v4/leads/unsorted/forms` ## Request - Base URL: `https://subdomain.kommo.com` - URL: `https://subdomain.kommo.com/api/v4/leads/unsorted/forms` - Auth: OAuth 2 Este método permite adicionar múltiplos ou um único lead de entrada. ## Request body - object - `RAW_BODY` object[] - `source_uid` string, required: UID da fonte do lead entrante. Gerado pela integração - `source_name` string, required: Nome da fonte do lead entrante - `pipeline_id` string: ID do pipeline ao qual o lead entrante será adicionado - `created_at` string: Data de criação do lead entrante no formato Unix Timestamp - `metadata` object: Metadados do lead entrante. Campo obrigatório - `form_id` integer: ID do formulário da integração - `form_name` string: Nome do formulário - `form_page` string: Página web onde o formulário está instalado - `ip` string: Endereço IP da solicitação - `form_sent_at` integer: Data e hora do envio do formulário no formato Unix Timestamp - `referer` string: Página web de onde o solicitante foi redirecionado para a página do formulário - `_embedded` object[] - `contacts` object[]: Dados relacionados ao contato do lead entrante. Sempre consiste em um único objeto - `id` integer: ID do Contato - `name` string: Nome completo do Contato - `first_name` string: Nome do Contato - `last_name` string: Sobrenome do Contato - `responsible_user_id` integer: ID do Usuário responsável do Contato - `created_by` integer: ID do Usuário que criou o Contato - `updated_by` string: ID do Usuário que atualizou o Contato por último - `created_at` integer: Data de criação do Contato no formato de Unix Timestamp - `updated_at` integer: Data de atualização do Contato no formato de Unix Timestamp - `custom_fields_values` string: Um array dos valores atuais dos campos personalizados do Contato - `request_id` string: O campo será retornado inalterado na resposta e não será salvo. - `tags_to_add` object[]: Array de tags a serem adicionadas. Você precisa passar o nome ou o ID da tag. - `id` integer: ID da tag - `name` string: Nome da tag - `companies` object[]: Dados relacionados à empresa do lead entrante. Sempre consiste em um único objeto - `id` string: ID da Empresa - `name` string: Nome da Empresa - `responsible_user_id` integer: ID do Usuário responsável da Empresa - `created_by` integer: ID do Usuário que criou a Empresa - `updated_by` integer: ID do Usuário que atualizou a Empresa por último - `created_at` integer: Data de criação da Empresa no formato de Unix Timestamp - `updated_at` integer: Data de atualização da Empresa no formato de Unix Timestamp - `custom_fields_values` string, json: Um array dos valores atuais dos campos personalizados da Empresa - `_embedded` object[] - `id` integer: ID da tag - `name` string: Nome da tag - `request_id` string: O campo será retornado inalterado na resposta e não será salvo. - `tags_to_add` object[]: Array de tags a serem adicionadas. Você precisa passar o nome ou o ID da tag. - `id` integer: ID da tag - `name` string: Nome da tag - `leads` object[]: Dados relacionados ao lead ao qual o lead entrante está conectado. Sempre consiste em um único objeto - `name` string: Nome do Lead - `price` integer: Venda do Lead - `status_id` integer: ID da Etapa à qual o Lead foi adicionado, sendo a primeira etapa do pipeline principal a padrão - `pipeline_id` integer: ID do Pipeline ao qual o Lead foi adicionado - `created_by` integer: O ID do usuário que cria o Lead. Ao passar o valor 0, o lead será considerado como criado pelo robô. - `updated_by` integer: O ID do usuário que atualiza o Lead. Ao passar o valor 0, o lead será considerado como atualizado pelo robô. - `created_at` integer: A data e hora em que o lead foi criado no formato de Unix Timestamp - `updated_at` integer: A data e hora em que o lead foi atualizado no formato de Unix Timestamp - `closed_at` integer: A data e hora em que o lead foi fechado no formato de Unix Timestamp - `loss_reason_id` string: ID da razão da perda - `responsible_user_id` integer: ID do usuário responsável pelo Lead - `custom_fields_values` string, json: Um array contendo informações sobre os valores dos campos personalizados especificados para este Lead - `_embedded` object: Entidades incorporadas do Lead - `tags` object[]: Tags anexadas ao Lead - `id` integer: ID da tag - `name` string: Nome da tag - `contacts` object[]: Contatos anexados ao Lead - `id` integer: ID do Contato - `is_main` boolean: Indica se o contato é o principal ou não - `companies` object[]: Company attached to the lead. you can assign only 1 company. - `id` integer: ID da Empresa - `source` object: Source of the lead - `external_id` string: O ID externo da fonte. Uma fonte pode ser adicionada usando a API de Fontes. Se o external_id da fonte for passado e o pipeline_id não for passado, o lead será adicionado ao pipeline onde a fonte está localizada. - `type` string: Tipo de fonte. Para leads adicionados por integrações, apenas o widget é suportado. - `tags_to_add` object[]: Array de tags a serem adicionadas. Você precisa passar o nome ou o ID da tag. - `id` integer: ID da tag - `name` string: Nome da tag - `tags_to_delete` object[]: Array de tags a serem deletadas. Você precisa passar o nome ou o ID da tag. - `id` integer: ID da tag - `name` string: Nome da tag - `request_id` string: Campo que será retornado sem alterações na resposta e não será salvo ## Response `200` 200 - object - `_total_items` integer - `_embedded` object - `unsorted` object[] - `uid` string - `account_id` integer - `request_id` string - `_links` object - `self` object - `href` string - `_embedded` object - `contacts` object[] - `id` integer - `_links` object - `self` object - … - `leads` object[] - `id` integer - `_links` object - `self` object - … - `companies` unknown[] - unknown ## Other responses - `400`: 400 - `401`: 401 --- [API](https://skmtc.dev/kommo/apis/referencias-de-api-da-kommo.md) - [All operations](https://skmtc.dev/kommo/apis/referencias-de-api-da-kommo/llms.txt) - [OpenAPI document](https://skmtc.dev/kommo/apis/referencias-de-api-da-kommo/revisions/55101699dddb?raw)