Documentación
superleads.mx
Documentación › Referencia de la API › Oportunidades

Oportunidades

Referencia de la API · ☕ 7 min de lectura
Actualizado el 19 Jun 2026

En el contexto de un colegio o universidad, una "oportunidad" suele representar un proceso de admision o inscripcion en curso: un prospecto que esta avanzando por las etapas de tu embudo (interesado, documentación en revisión, entrevista, inscrito, etc.). Esta página describe los endpoints para leer, crear y actualizar esos procesos por API — útil si tu equipo quiere sincronizar el estado de admisiones con un sistema academico propio, o automatizar el seguimiento de prospectos.

API de Oportunidades v3

Documentación de la API de Oportunidades (pipeline de ventas).

Versión de la API v3

Todas las APIs disponibles bajo el prefijo de ruta /v3 con respuestas compatibles con AIP.

Servidor base: https://services.leadconnectorhq.com

Endpoints

GET /opportunities/lost-reason

Obtener motivos de perdida

Scopes requeridos: opportunities.readonly

Parametros:

  • Versión (header, string) (requerido) — Versión de la API
  • locationId (query, string) (requerido) — Identificador de la ubicacion (sub-cuenta)
  • name (query, string) — nombre del motivo de perdida
  • deleted (query, boolean) — eliminado
  • query (query, string) — texto de busqueda
  • skip (query, number) — registros a saltar
  • limit (query, number) — límite de resultados
  • getCount (query, boolean) — obtener el conteo total

Respuestas:

  • 200 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable

GET /opportunities/search

Buscar oportunidad

Scopes requeridos: opportunities.readonly

Parametros:

  • Versión (header, string) (requerido) — Versión de la API
  • q (query, string) — Texto de busqueda (máximo 75 caracteres)
  • status (query, string) — Filtrar por estado de la oportunidad
  • campaignId (query, string) — Id de la campaña
  • id (query, string) — Id de la oportunidad
  • order (query, string) — Orden de los resultados (ej. added_asc, added_desc, name_asc, name_desc)
  • endDate (query, string) — Fecha final
  • startAfter (query, string) — Comenzar después de (cursor)
  • startAfterId (query, string) — Comenzar después de este Id
  • date (query, string) — Fecha de inicio
  • country (query, string) — Filtrar por código de país (ISO 3166-1 alpha-2)
  • page (query, number) — Número de página para paginacion
  • limit (query, number) — Cantidad de registros por página. Máximo 100, valor por defecto 20
  • getTasks (query, boolean) — incluir tareas del contacto
  • getNotes (query, boolean) — incluir notas del contacto
  • getCalendarEvents (query, boolean) — incluir eventos de calendario del contacto
  • locationId (query, string) (requerido) — Id de la ubicacion
  • pipelineId (query, string) — Id del pipeline
  • pipelineStageId (query, string) — Id de la etapa
  • contactId (query, string) — Id del contacto
  • assignedTo (query, string) — Filtrar por usuario asignado

Respuestas:

  • 200 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable

POST /opportunities/search

Buscar oportunidades (avanzado)

Busca oportunidades combinando filtros avanzados. Enlace a documentación - https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f

Scopes requeridos: opportunities.readonly

Parametros:

  • Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json):

  • locationId (requerido) — string — Id de la ubicacion
  • query (requerido) — string — Texto de busqueda de texto completo (máximo 75 caracteres)
  • limit (requerido) — number — Número máximo de resultados por página
  • page (requerido) — number — Número de página (empieza en 0)
  • searchAfter (requerido) — array — Valores de cursor "search-after" para paginacion profunda
  • additionalDetails (requerido) — — Banderas para incluir entidades relacionadas adicionales en la respuesta

Respuestas:

  • 200 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable

GET /opportunities/pipelines

Obtener pipelines

Scopes requeridos: opportunities.readonly

Parametros:

  • Versión (header, string) (requerido) — Versión de la API
  • locationId (query, string) (requerido) — Identificador de la ubicacion (sub-cuenta) de la que se obtienen los pipelines

Respuestas:

  • 200 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado

GET /opportunities/{id}

Obtener oportunidad

Scopes requeridos: opportunities.readonly

Parametros:

  • Versión (header, string) (requerido) — Versión de la API
  • id (path, string) (requerido) — Id de la oportunidad

Respuestas:

  • 200 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable

DELETE /opportunities/{id}

Eliminar oportunidad

Scopes requeridos: opportunities.write

Parametros:

  • Versión (header, string) (requerido) — Versión de la API
  • id (path, string) (requerido) — Id de la oportunidad

Respuestas:

  • 200 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable

PUT /opportunities/{id}

Actualizar oportunidad

Scopes requeridos: opportunities.write

Parametros:

  • Versión (header, string) (requerido) — Versión de la API
  • id (path, string) (requerido) — Id de la oportunidad

Cuerpo de la peticion (application/json):

  • pipelineId — string — Id del pipeline
  • name — string — Nombre de la oportunidad
  • pipelineStageId — string — Identificador de la etapa del pipeline
  • status — string — Estado actual de la oportunidad
  • monetaryValue — number — Valor monetario de la oportunidad
  • forecastExpectedCloseDate — string — Fecha esperada de cierre. Formatos soportados: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, o ISO 8601
  • forecastProbability — number — Probabilidad de pronostico
  • assignedTo — string — Identificador del usuario asignado a la oportunidad
  • customFields — array — Actualiza campos personalizados de la oportunidad

Respuestas:

  • 200 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable

PUT /opportunities/{id}/status

Actualizar estado de la oportunidad

Scopes requeridos: opportunities.write

Parametros:

  • Versión (header, string) (requerido) — Versión de la API
  • id (path, string) (requerido) — Id de la oportunidad

Cuerpo de la peticion (application/json):

  • status (requerido) — string — Nuevo estado de la oportunidad
  • lostReasonId — string — Id del motivo de perdida

Respuestas:

  • 200 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable

POST /opportunities/upsert

Crear o actualizar oportunidad (upsert)

Scopes requeridos: opportunities.write

Parametros:

  • Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json):

  • id — string — Id de la oportunidad
  • pipelineId (requerido) — string — Id del pipeline
  • locationId (requerido) — string — Id de la ubicacion
  • followers (requerido) — array — Id(s) de contacto de los seguidores
  • isRemoveAllFollowers (requerido) — boolean — Eliminar todos los seguidores
  • followersActionType (requerido) — string — Tipo de acción sobre los seguidores
  • name — string — nombre
  • status — string — Estado actual de la oportunidad
  • pipelineStageId — string — Identificador de la etapa del pipeline
  • monetaryValue — object — Valor monetario de la oportunidad
  • forecastExpectedCloseDate — string — Fecha esperada de cierre. Formatos soportados: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, o ISO 8601
  • forecastProbability — number — Probabilidad de pronostico
  • assignedTo — string — Identificador del usuario asignado a la oportunidad
  • lostReasonId — string — Id del motivo de perdida

Respuestas:

  • 200 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable

POST /opportunities/{id}/followers

Agregar seguidores

Scopes requeridos: opportunities.write

Parametros:

  • Versión (header, string) (requerido) — Versión de la API
  • id (path, string) (requerido) — Id de la oportunidad

Cuerpo de la peticion (application/json):

  • followers (requerido) — array — Arreglo de IDs de usuario a agregar o quitar como seguidores (máximo 10)

Respuestas:

  • 201 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable

DELETE /opportunities/{id}/followers

Quitar seguidores

Permite quitar uno o todos los seguidores de una oportunidad.

Scopes requeridos: opportunities.write

Parametros:

  • Versión (header, string) (requerido) — Versión de la API
  • id (path, string) (requerido) — Id de la oportunidad
  • isRemoveAllFollowers (query, boolean) — Ponlo en true para quitar todos los seguidores de la oportunidad

Cuerpo de la peticion (application/json):

  • followers (requerido) — array — Arreglo de IDs de usuario a agregar o quitar como seguidores (máximo 10)

Respuestas:

  • 200 — Seguidores eliminados exitosamente.
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable

POST /opportunities/

Crear oportunidad

Scopes requeridos: opportunities.write

Parametros:

  • Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json):

  • pipelineId (requerido) — string — Id del pipeline
  • locationId (requerido) — string — Identificador de la ubicacion (sub-cuenta)
  • name (requerido) — string — Nombre de la oportunidad
  • pipelineStageId — string — Identificador de la etapa del pipeline
  • status (requerido) — string — Estado actual de la oportunidad
  • contactId (requerido) — string — Identificador del contacto vinculado a la oportunidad
  • monetaryValue — number — Valor monetario de la oportunidad
  • forecastExpectedCloseDate — string — Fecha esperada de cierre. Formatos soportados: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, o ISO 8601
  • forecastProbability — number — Probabilidad de pronostico
  • assignedTo — string — Identificador del usuario asignado a la oportunidad
  • customFields — array — Agrega campos personalizados a la oportunidad

Respuestas:

  • 201 — Respuesta exitosa
  • 400 — Peticion invalida
  • 401 — No autorizado
  • 422 — Entidad no procesable
Enter para abrir el primer resultado · Esc para cerrar