Recursos y ejemplos de API
Flujos, formularios, contactos y oportunidades con ejemplos completos.
Flujos y formularios
Consulta primero GET /flows. Cada flujo entrega un id público y sus formularios con el esquema que define las claves válidas de data.
GET /flows
GET /flows/{flow_id}Crear una oportunidad
La creación requiere Idempotency-Key. Repetir la misma solicitud con la misma clave durante 24 horas devuelve la primera respuesta sin duplicar el registro.
curl -X POST "$BASE/opportunities" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: pedido-erp-98421" \
-d '{
"flow_id": "codigo-del-flujo",
"form_id": "codigo-del-formulario",
"external_id": "ERP-98421",
"data": {
"nombres": "Ana Torres",
"email": "ana@example.com",
"celular": "+51999999999"
},
"utm_source": "erp"
}'Crear o completar data también activa la consolidación automática del contacto cuando existen nombre, email, teléfono o documento suficientes.
Completar una oportunidad
PATCH /opportunities/{id}
{
"data": {"dni": "12345678", "cargo": "Gerente"}
}El objeto data se combina con los datos existentes. La API v1 no cambia etapas o estados: esos movimientos obedecen reglas y motivos configurados en el CRM.
Listados y filtros
| Endpoint | Filtros |
|---|---|
GET /flows | page, per_page |
GET /opportunities | flow_id, form_id, state_id, updated_since, page, per_page |
GET /contacts | q (mínimo 2 caracteres), updated_since, page, per_page |
per_page admite de 1 a 100; el valor predeterminado es 50.