Upnify Documentación API
CRM · /campanias/:tkCampania

Comunicaciones

Campaña - Detalle

GET/campanias/:tkCampania

Obtiene el detalle de una campaña.

Parámetros

NombreTipoValidaciónDescripción
tkCampaniaStringRequeridoCódigo token de la campaña.

Respuesta

NombreTipoDescripción
idCampaniaIntegerIdentificador interno de la campaña.
tkCampaniaStringCódigo token que identifica la campaña.
tipoIntegerTipo de campaña.
nombreStringNombre de la campaña.
situacionIntegerSituación actual de la campaña.
aplicaProspectoIntegerIndica si la campaña aplica a prospectos.
aplicaOportunidadIntegerIndica si la campaña aplica a oportunidades.
aplicaClienteIntegerIndica si la campaña aplica a clientes.
inicialesStringIniciales del usuario responsable.
etiquetaStringNombre de la etiqueta asociada.
colorStringColor de la etiqueta asociada.
tkEtiquetaStringCódigo token de la etiqueta asociada.
nombreEjecutivoStringNombre del ejecutivo responsable.
piezasIntegerCantidad de piezas configuradas.
asignadosIntegerCantidad de contactos asignados.
tkUsuarioStringCódigo token del usuario responsable.
tkEmpresaStringCódigo token de la empresa.
objetivoCantidadIntegerCantidad objetivo configurada.
objetivoMontoNumberMonto objetivo configurado.
avanceCantidadIntegerCantidad alcanzada.
avanceMontoNumberMonto alcanzado.
fechaInicioDateTimeFecha y hora de inicio.
fechaFinDateTimeFecha y hora de finalización.
asuntoStringAsunto del mensaje.
tipoRemitenteIntegerTipo de remitente utilizado.
enviadoPorStringCódigo token del remitente.
anexosArray<Object>Archivos anexos asociados.
cuerpoStringContenido del mensaje.

Solicitud

Ejemplo de solicitud

curl --request GET 'https://api.upnify.com/campanias/CAM-00000000-0000-4000-8000-000000000010' \
  --header 'token: 00000000-0000-4000-8000-000000000001'

Respuesta

Ejemplo de respuesta

JSON
[
  {
    "idCampania": 10,
    "tkCampania": "CAM-00000000-0000-4000-8000-000000000010",
    "tipo": 2,
    "nombre": "Campaña de ejemplo",
    "situacion": 1,
    "aplicaProspecto": 1,
    "aplicaOportunidad": 0,
    "aplicaCliente": 0,
    "iniciales": "UE",
    "etiqueta": "Clientes potenciales",
    "color": "#FF2D6A",
    "tkEtiqueta": "00000000-0000-4000-8000-000000000013",
    "nombreEjecutivo": "Usuario de ejemplo",
    "piezas": 1,
    "asignados": 1,
    "tkUsuario": "00000000-0000-4000-8000-000000000014",
    "tkEmpresa": "00000000-0000-4000-8000-000000000015",
    "objetivoCantidad": 0,
    "objetivoMonto": 0,
    "avanceCantidad": 0,
    "avanceMonto": 0,
    "fechaInicio": "2026-09-20T09:00:00",
    "fechaFin": "2026-09-30T18:00:00",
    "asunto": "Asunto de ejemplo",
    "cuerpo": "Contenido de ejemplo.",
    "tipoRemitente": 1,
    "enviadoPor": null,
    "anexos": []
  }
]