Skip to main content
Version: Latest

Paso 2 — Completar datos del Lead

Completa los datos del cliente creado en el Paso 1 (contraseña, nombre completo, teléfono). El seed retornado en la respuesta es el identificador único del proceso y debe conservarse para los pasos siguientes.

Prerequisito

El cliente debe haber completado el Paso 1 — Aceptar Términos antes de llamar este endpoint. Si no existe el registro, la API retorna error 412: El cliente no ha aceptado los terminos y condiciones.

Request 🚀​

URL​

https://api.aveonline.co/api-onboarding/public/api/v1/external/onboarding/createLead

Method​

POST

Headers​

Content-Type: application/json
Accept: application/json
Authorization: Bearer {tu_token_jwt}

Body JSON​

Campos requeridos​

  • name* String min:6, max:255 — Nombre completo del prospecto
  • email* String email, max:255 — Correo electrónico
  • phone* Numeric — Número de teléfono sin indicativo
  • password* String min:6, max:100 — Contraseña de acceso

Campos opcionales​

  • phoneCode String — Indicativo del país. Ej: +57
  • idCampaign String max:255 — ID de la campaña de origen
  • urlLeadSource String max:255 — URL de la plataforma externa que origina el registro
  • numberShipments String — Volumen estimado de envíos mensuales. Valores: 0-100 101-500 501-1000 +1000
  • ecommerce String — Plataforma ecommerce del cliente. Ej: Shopify, WooCommerce
  • keybe String max:255 — ID del contacto en Keybe (si aplica)
  • codeIso String max:255 — Código ISO del país. Ej: CO

Ejemplo de payload​

{
  "name": "Juan Carlos Perez",
  "email": "juancarlos@empresa.com",
  "phone": "3108001234",
  "password": "miPassword123",
  "phoneCode": "+57",
  "urlLeadSource": "https://miplataforma.com",
  "numberShipments": "0-100"
}

Response​

201 — Lead creado correctamente​

{
  "status": "ok",
  "message": "Lead created",
  "data": {
    "seed": "994f9ccf-d22b-4cea-9565-3920d2ba2bbe",
    "nextGtmEvent": "NEW_LEAD"
  }
}
  • seed String (UUID) — Identificador del proceso. Úsalo en los pasos 2, 3 y 4.

211 — Ya tiene proceso en curso​

El email ya inició un proceso de onboarding. Se retorna el seed existente para que puedas retomarlo.

{
  "status": "ok",
  "message": "Its already boarding process",
  "data": {
    "seed": "994f9ccf-d22b-4cea-9565-3920d2ba2bbe"
  }
}

212 — Email ya existe como empresa en AVE​

{
  "errors": [
    {
      "title": "Error control",
      "detail": "The email already exists in Companies"
    }
  ]
}

422 — Error de validación​

{
  "errors": [
    {
      "title": "name",
      "detail": "nombre must be at least 6 characters"
    }
  ]
}

409 — Error al guardar​

{
  "errors": [
    {
      "title": "Error control",
      "detail": "Error trying to save data"
    }
  ]
}

Notas importantes​

  • Si recibes código 211, no es un error. Puedes continuar el proceso usando el seed retornado.
  • El campo urlLeadSource es la forma de registrar de dónde viene el registro, úsalo siempre.