---
title: "Añadir leads entrantes del tipo formulario"
method: POST
path: "/api/v4/leads/unsorted/forms"
---

# Añadir leads entrantes del tipo formulario

`POST /api/v4/leads/unsorted/forms`

Este método permite añadir uno o varios leads entrantes.

## Headers

- `Content-Type` string

## Request body

- object
  - `RAW_BODY` object[]
    - `source_uid` string, required — UID de la fuente del lead entrante. Generado por la integración
    - `source_name` string, required — Nombre de la fuente del lead entrante
    - `pipeline_id` integer — ID del pipeline al que se añadirá el lead entrante
    - `created_at` integer — Fecha de creación del lead entrante en formato de Unix Timestamp
    - `metadata` object — Metadatos del lead entrante. Revisa los parámetros de metadatos de tipo SIP. Campo requerido.
      - `form_id` string — ID del formulario de la integración
      - `form_name` string — Nombre del formulario
      - `form_page` string — Página web donde está instalado el formulario
      - `ip` string — Dirección IP de la solicitud
      - `form_sent_at` integer — Fecha y hora del envío del formulario en formato Unix Timestamp
      - `referer` string — Página web desde la que el solicitante fue redirigido a la página del formulario
    - `_embedded` object
      - `contacts` object[] — Datos relacionados con el contacto del lead entrante. Siempre consiste en un objeto.
        - `id` integer — ID del contacto
        - `name` string — Nombre completo del contacto
        - `first_name` string — Nombre del contacto
        - `last_name` string — Apellido del contacto
        - `responsible_user_id` integer — ID del contacto responsable
        - `created_by` integer — ID del usuario que creó el contacto
        - `updated_by` integer — ID del usuario que actualizó el contacto por última vez
        - `created_at` integer — Fecha de creación del contacto en formato de Unix Timestamp
        - `updated_at` integer — Fecha de actualización del contacto en formato de Unix Timestamp
        - `custom_fields_values` string, json — Un arreglo de los valores actuales de los campos personalizados del contacto
        - `_embedded` object
          - `tags` object[]
            - `id` integer — ID de la etiqueta.
            - `name` string — Nombre de la etiqueta.
        - `tags_to_add` object[] — Arreglo de etiquetas para añadir Debes pasar ya sea el nombre o el ID de la etiqueta.
          - `id` integer — ID de la etiqueta.
          - `name` string — Nombre de la etiqueta.
        - `request_id` string — El campo será retornado sin cambios en la respuesta y no se guardará.
      - `companies` object[] — Datos relacionados con la compañía del lead entrante. Siempre consiste en un objeto.
        - `id` integer — ID de la compañía
        - `name` string — Nombre de la compañía
        - `responsible_user_id` integer — ID del usuario responsable de la compañía
        - `created_by` integer — El ID del usuario que creó la compañía
        - `updated_by` integer — El ID del usuario que actualizó la compañía por última vez
        - `created_at` integer — Fecha de creación de la compañía en formato de Unix Timestamp
        - `updated_at` integer — Fecha de actualización de la compañía en formato de Unix Timestamp
        - `custom_fields_values` string, json — Un arreglo de los valores actuales de los campos personalizados de la compañía
        - `_embedded` object
          - `tags` object[]
            - `id` integer — ID de la etiqueta.
            - `name` string — Nombre de la etiqueta.
        - `tags_to_add` object[] — Arreglo de etiquetas para añadir Debes pasar ya sea el nombre o el ID de la etiqueta.
          - `id` integer — ID de la etiqueta.
          - `name` string — Nombre de la etiqueta.
        - `request_id` string — El campo será retornado sin cambios en la respuesta y no se guardará.
      - `leads` object[] — Datos relacionados con el lead al que el lead entrante está conectado. Siempre consiste en un objeto.
        - `name` string — Nombre del lead
        - `price` integer — Venta del lead
        - `status_id` integer — ID de la etapa a la que se añade el lead. Por defecto, es la primera etapa del pipeline principal.
        - `pipeline_id` integer — ID del pipeline al que se añade el lead.
        - `created_by` integer — El ID del usuario que crea el lead. Al pasar el valor 0, el lead será considerado como creado por el robot.
        - `updated_by` integer — El ID del usuario que actualiza el lead. Al pasar el valor 0, el lead será considerado como creado por el robot.
        - `created_at` integer — Fecha de creación del lead en formato de Unix Timestamp.
        - `updated_at` integer — Fecha de actualización del lead en formato de Unix Timestamp.
        - `closed_at` integer — Fecha de cierre del lead en formato de Unix Timestamp.
        - `loss_reason_id` integer — ID del motivo de pérdida del lead.
        - `responsible_user_id` integer — ID del usuario responsable del lead.
        - `custom_fields_values` string, json — Un arreglo de los valores actuales de los campos personalizados del lead.
        - `_embedded` object — Entidades asociadas del lead.
          - `tags` object[] — Etiquetas vinculadas al lead
            - `id` integer — ID de la etiqueta.
            - `name` string — Nombre de la etiqueta.
          - `contacts` object[] — Contactos vinculados al lead
            - `id` integer — ID del contacto
            - `is_main` boolean — Indica si el contacto es principal o no
          - `companies` object[] — Compañía vinculada al lead. Puedes asignar solo 1 compañía
            - `id` integer — ID de la compañía
          - `source` object — Fuente del lead.
            - `external_id` string — ID externo de la fuente. Una fuente puede ser añadida utilizando la API de Fuentes. Si se pasa el external_id de la fuente y no se pasa el pipeline_id, el lead se añadirá al pipeline donde se encuentra la fuente.
            - `type` string — Tipo de fuente. Para leads añadidos por integraciones, solo se admite el widget.
        - `tags_to_add` object[] — Arreglo de etiquetas para añadir Debes pasar ya sea el nombre o el ID de la etiqueta.
          - `id` integer — ID de la etiqueta.
          - `name` string — Nombre de la etiqueta.
    - `request_id` string — Campo que será retornado sin cambios en la respuesta y que no será guardado.

## 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/kommo-api.md) · [All operations](https://skmtc.dev/kommo/apis/kommo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kommo/kommo-api/revisions/e291c0b2038d/schema)
