API Campañas

Esta API permite gestionar campañas de marketing de la empresa, incluyendo consulta, creación, modificación y eliminación de registros.

La funcionalidad asociada en el sistema se encuentra en Configuración > Campañas.

Endpoint del servicio

Método Query

Permite obtener un listado de campañas aplicando filtros.

Parámetros de entrada

Parámetro Tipo Obligatorio Descripción
CodigoDesde T(3) No Código inicial del rango.
CodigoHasta T(3) No Código final del rango.
NombreContiene T(20) No Filtro por nombre de campaña.
Page N(2) Número de página.

Estructura del response

Codigo
Nombre

Método Load

Permite obtener una campaña específica.

Parámetro de entrada

  • Codigo – Obligatorio.

Resultado

Codigo
Nombre

Método Save

Permite crear o actualizar una campaña.

Parámetros de entrada

Campo Obligatorio Descripción
Codigo Identificador de la categoría.
Nombre Nombre de la categoría.

Resultado

Succeed
Error
Mensaje

Método Delete

Permite eliminar una campaña.

Parámetro de entrada

  • Codigo – Obligatorio.

Resultado

Succeed
Error
Mensaje

Observaciones

  • El método Query permite consultas masivas de campañas.
  • El método Load es recomendado para consultas puntuales.
  • El método Save permite tanto alta como modificación.
  • Las campañas pueden ser utilizadas en oportunidades de venta para análisis comercial.

Consideraciones de integración

  • Utilizar paginación en consultas.
  • Evitar consultas masivas frecuentes sin filtros.
  • Validar existencia de la campaña antes de asignarla a procesos comerciales.
Compartir

API Campañas

O copia el enlace

CONTENIDO