Ir al contenido

Configuración de la empresa por API

La empresa decide cómo se ven y cómo se emiten sus documentos: con qué logo, con qué plantilla, en qué modo se emiten por defecto las boletas de honorarios, las facturas y las boletas, qué información de pago se imprime y con qué clave se conecta a ValidaFirma. Esta ficha deja que un agente haga por API lo que la persona hace en el panel, en Configuración. Son setenta y siete operaciones, con las mismas reglas y los mismos mensajes de rechazo que el panel.

Esta ficha cubre la configuración documental de la empresa y su configuración general: topes de ValidaFirma, registro de llamadas de las llaves, suscripción, PIN, canal de agentes, ventas y correo. No incluye las llaves de API: una llave no administra llaves. Otras partes de la configuración tienen su propia ficha, por ejemplo Configuración de Comunicación.

ParaOperaciones
La clave de ValidaFirmaobtenerConfiguracionValidafirma, crearConfiguracionValidafirma, actualizarConfiguracionValidafirma, eliminarConfiguracionValidafirma
El logo de la empresasubirLogoDeEmpresa, obtenerLogoDeEmpresa, eliminarLogoDeEmpresa
El modo de emisión por defectoobtenerConfiguracionBhe y actualizarConfiguracionBhe; lo mismo para Bhet, Dte y Boleta
La caché de contribuyentesobtenerCacheDeContribuyentes, actualizarCacheDeContribuyentes
La información de pago de los documentosobtenerInformacionDePago, actualizarInformacionDePago, eliminarInformacionDePago
El catálogo de plantillas de la plataformalistarPlantillasDelCatalogo, obtenerPlantillaDelCatalogo, listarTiposDeDocumentoDePlantilla, listarFormatosDePapel
Las vistas previasgenerarVistaPreviaDePlantilla, generarVistaPreviaDePlantillaConDatos, generarVistaPreviaDePlantillaDeEmpresa
Las plantillas que eligió la empresaobtenerPlantillasDeEmpresa, actualizarPlantillasDeEmpresa, listarOpcionesDePlantilla
Los topes de ValidaFirmaobtenerTopesDeValidaFirma, obtenerHistorialDeProteccionValidaFirma, crearSolicitudDeTopeValidaFirma
El registro de llamadas de las llaveslistarLlamadasDeLlaves
La suscripciónlistarAdicionalesDeMiSuscripcion, obtenerAdicionalDeMiSuscripcion, obtenerPlanDeMiSuscripcion, obtenerResumenDePagosDeMiSuscripcion
El PINlistarIntegracionesPin, crearIntegracionPin, actualizarIntegracionPin, desactivarIntegracionPin, reactivarIntegracionPin, obtenerEstadisticasDeIntegracionPin
El canal de agenteslistarActividadDelCanalDeAgentes, listarOpcionesDeActividadDelCanalDeAgentes, listarConexionesDelCanalDeAgentes, listarHechosDelCanalDeAgentes, obtenerEstadoDelCanalDeAgentes, desactivarCanalDeAgentes, activarCanalDeAgentes, quitarConexionDelCanalDeAgentes
Las casillas de ventaslistarCasillasDeVentas, listarAlertasDeCasillasDeVentas, reclamarCasillaDeVentas, quitarCasillaDeVentas
Los campos de la notalistarCamposDeLaNota, crearCampoDeLaNota, obtenerCampoDeLaNota, actualizarCampoDeLaNota, archivarCampoDeLaNota
La configuración de correo y sus identidadesobtenerConfiguracionDeCorreo, actualizarConfiguracionDeCorreo, listarIdentidadesDeCorreo, crearIdentidadDeCorreo, actualizarIdentidadDeCorreo, eliminarIdentidadDeCorreo, verificarConexionDeIdentidadDeCorreo, enviarPruebaDeIdentidadDeCorreo
Las plantillas de correolistarPlantillasDeCorreo, listarAsignacionesDePlantillasDeCorreo, obtenerContenidoPorDefectoDePlantillaDeCorreo, obtenerPlantillaDeCorreo, crearPlantillaDeCorreo, actualizarPlantillaDeCorreo, eliminarPlantillaDeCorreo, generarVistaPreviaDePlantillaDeCorreo

La clave de ValidaFirma se escribe y no se lee

Sección titulada «La clave de ValidaFirma se escribe y no se lee»

Ninguna operación devuelve la clave de ValidaFirma, ni siquiera a la llave que la escribió. Las respuestas traen claveConfigurada (true o false) y si la integración está activo, nada más. Si necesitas saber si hay una clave, lee claveConfigurada; si la persona perdió la clave, no hay cómo recuperarla por API: se reemplaza por una nueva.

  • crearConfiguracionValidafirma guarda la clave y activa la integración. Responde 409 si la empresa ya tiene una configuración: para cambiarla, usa la operación de actualizar.
  • actualizarConfiguracionValidafirma activa o desactiva la integración y, sólo si mandas apiKey, reemplaza la clave. Un PUT sin apiKey conserva la clave guardada: para activar o desactivar no necesitas conocerla.
  • eliminarConfiguracionValidafirma borra la clave y la configuración. Responde 404 si no había configuración.

No imprimas la clave, no la pidas por el chat ni la dejes en un archivo versionado. La persona la escribe o la deja en un archivo fuera del repositorio, y tú la lees de ahí sólo para armar el cuerpo.

Ninguna operación de correo devuelve la contraseña SMTP, ni a la llave que la escribió. Una identidad responde hasPassword (true o false) y nunca la contraseña, ni cifrada, ni su sal ni su huella. Si la persona la perdió, no hay cómo recuperarla por API: se reemplaza por otra con actualizarIdentidadDeCorreo.

No pongas la contraseña en la línea de comandos ni en el chat. Con el CLI, el cuerpo de correo identidades crear y correo identidades actualizar va por --cuerpo @archivo (un archivo fuera del repositorio) o por la entrada estándar con --cuerpo -; el CLI no imprime el cuerpo.

  • Una llave con acceso a la configuración. La llave del proyecto que instala redcumbre init es FULL-API y alcanza. Las operaciones de plantillas declaran el rol de administración de plantillas; redcumbre api describir actualizarPlantillasDeEmpresa muestra el rol exacto de cada una.
  • El archivo de la llave en el proyecto, como en Modo de prueba y producción. No lo leas, no lo imprimas ni le pidas a la persona que pegue el secreto en el chat.
  • Un cuerpo sólo con los campos que la operación declara: un campo de más responde 400 y no se guarda nada.
  • Paginación, errores y límites: Reglas comunes.

Con una llave de prueba, las setenta y siete operaciones responden desde un conjunto de ejemplo y no guardan nada: ni la clave de ValidaFirma, ni el logo, ni los modos, ni las plantillas, ni los topes, ni el PIN, ni el canal, ni las casillas, ni el correo de la empresa. Las lecturas devuelven los datos del conjunto de ejemplo (una empresa sintética, RUT 76.123.456-0); las escrituras validan el cuerpo como en producción y responden como si hubieran guardado, sin cambiar nada y sin llamar a ValidaFirma. Ninguna se cobra.

  • El logo de prueba es una imagen de ejemplo del sitio de documentación: obtenerLogoDeEmpresa devuelve /ejemplos/logo-de-ejemplo.png, que se abre en https://docs.redcumbre.cl/ejemplos/logo-de-ejemplo.png. subirLogoDeEmpresa responde como subido y eliminarLogoDeEmpresa como eliminado, sin tocar el logo de la empresa.

  • La configuración de ValidaFirma de prueba trae claveConfigurada: true, sin haber leído la clave de la empresa.

  • La vista previa de la empresa se arma con una empresa de ejemplo y su logo de ejemplo.

  • El catálogo de plantillas, los tipos de documento y los formatos de papel son fijos y no dependen de ninguna empresa: con una llave de prueba responden igual que en producción.

  • El registro de llamadas de prueba (listarLlamadasDeLlaves) responde las llamadas de la empresa hechas en modo de prueba, y no las de producción.

  • El contenido por defecto de una plantilla de correo (obtenerContenidoPorDefectoDePlantillaDeCorreo) es del sistema y no depende de la empresa: responde igual que en producción.

  • Las acciones del canal, del PIN, de las casillas y del correo (apagar, prender, quitar una conexión, crear una integración, tomar una casilla, enviar un correo de prueba) validan el cuerpo como en producción y responden como hechas, sin cambiar nada ni enviar nada.

Eso confirma que la llave, el rol y el cuerpo son correctos; no confirma que algo se haya guardado.

Cada paso usa el subcomando de redcumbre configuracion. Todos trabajan con la llave de prueba; para producción agrega --produccion --confirmar <slug-de-la-empresa>, y con --ensayo ves la petición sin hacerla. La alternativa genérica es redcumbre api <operationId>.

Ventana de terminal
redcumbre buscar "configuración de la empresa"
redcumbre api describir obtenerConfiguracionValidafirma

Resultado esperado: las operaciones de esta ficha, con su método, su ruta y los campos del cuerpo.

Ventana de terminal
redcumbre configuracion validafirma ver

Resultado esperado: si la integración está activa y claveConfigurada, sin la clave. Para guardar una nueva por primera vez:

{
"apiKey": "clave-de-prueba"
}

Para activar o desactivar sin cambiar la clave, manda sólo activo; si además quieres reemplazarla, suma apiKey:

{
"activo": true
}
Ventana de terminal
redcumbre configuracion validafirma actualizar --activo true

Resultado esperado: la configuración con claveConfigurada: true y el valor de activo; la clave no aparece en la respuesta. actualizar --activo no toca la clave. Para borrar la configuración: redcumbre configuracion validafirma quitar.

El CLI no lleva la clave. Ningún comando de redcumbre acepta un cuerpo con apiKey, ni por --cuerpo ni por redcumbre api: sale con código 2 y CUERPO_CON_CREDENCIAL, antes de llamar al API, para que la clave no pase por la terminal ni por el agente. Guardarla por primera vez o reemplazarla se hace desde el código del integrador, con una llamada HTTP a crearConfiguracionValidafirma o actualizarConfiguracionValidafirma y la llave en el encabezado, o desde el panel de la empresa.

Ventana de terminal
redcumbre configuracion logo subir --archivo logo.png
redcumbre configuracion logo ver
redcumbre configuracion logo quitar

Resultado esperado: tras subir, la URL del logo; obtenerLogoDeEmpresa devuelve la URL, o null si la empresa no tiene logo. La imagen es JPEG, PNG, GIF o WEBP de hasta 2 MB, va en el campo logo del formulario y se redimensiona. Un campo de texto de más responde 400. Eliminar un logo que no existe responde 404.

Hay un modo por tipo de documento: boletas de honorarios (Bhe), boletas de honorarios de terceros (Bhet), documentos tributarios (Dte) y boletas electrónicas (Boleta). Cada uno se lee y se cambia con su propio par de operaciones.

{
"bheModoDefault": "SINC_COMPLETO"
}
{
"bhetModoDefault": "SINC_PARCIAL"
}
{
"dteModoDefault": "ASINCRONO"
}
{
"boletaModoDefault": "SINCRONO"
}
Ventana de terminal
redcumbre configuracion bhe ver
redcumbre configuracion bhe cambiar --modo SINC_COMPLETO

Los otros tres tipos usan el mismo par: redcumbre configuracion bhet ver|cambiar, redcumbre configuracion dte ver|cambiar y redcumbre configuracion boleta ver|cambiar, cada uno con --modo.

Resultado esperado: el modo por defecto guardado. Los valores válidos son SINC_COMPLETO, SINC_PARCIAL y ASINCRONO para Bhe, Bhet y Dte, y SINCRONO y ASINCRONO para Boleta. Un valor fuera de esa lista responde 400. Es el modo por defecto de la empresa; qué hace cada modo al emitir está en Emisión.

{
"contribuyenteCacheTtlDays": 7
}
Ventana de terminal
redcumbre configuracion cache-contribuyentes ver
redcumbre configuracion cache-contribuyentes cambiar --cuerpo @cache.json

Resultado esperado: los días de vigencia guardados. Es un entero desde 1; con null la empresa vuelve al valor global. obtenerCacheDeContribuyentes devuelve null cuando usa el valor global.

{
"infoPagoHtml": "<p>Paga por transferencia a la cuenta indicada en tu cotización.</p>"
}
Ventana de terminal
redcumbre configuracion info-pago ver
redcumbre configuracion info-pago guardar --html '<p>Paga por transferencia a la cuenta indicada en tu cotización.</p>'
redcumbre configuracion info-pago quitar

Resultado esperado: el HTML guardado, ya saneado. Es el texto que se imprime en los documentos, con hasta 500 caracteres de texto: si excede, responde 400. obtenerInformacionDePago devuelve el HTML, o null si no hay.

Primero mira qué hay y para qué tipo de documento:

Ventana de terminal
redcumbre configuracion plantillas listar
redcumbre configuracion plantillas ver <id-de-la-plantilla>
redcumbre configuracion plantillas tipos-de-documento
redcumbre configuracion plantillas formatos-de-papel
redcumbre configuracion plantillas opciones documento_tributario.boleta_honorario

Resultado esperado: las plantillas de la plataforma (filtrables por tipo de documento, formato de papel y estado), los tipos de documento, los formatos de papel (carta, rollo de 80 mm, etc.), y para un tipo, las plantillas disponibles, la que eligió la empresa y la de la plataforma por defecto. Antes de elegir, mira cómo queda:

Ventana de terminal
redcumbre configuracion plantillas vista-previa-de-empresa <id-de-la-plantilla> --formato pdf --salida vista.pdf

Resultado esperado: el archivo vista.pdf con la plantilla armada con el nombre y el logo de la empresa (sin --formato, HTML). Si el logo no carga, se genera sin logo. redcumbre configuracion plantillas vista-previa <id> --salida vista.pdf hace lo mismo con datos de muestra del catálogo, y redcumbre configuracion plantillas vista-previa-con-datos <id> --cuerpo @datos.json mezcla esos datos con los tuyos:

{
"data": {
"cliente": "Cliente de ejemplo"
}
}

Elige la plantilla de cada tipo de documento:

{
"templates": {
"documento_tributario.boleta_honorario": "bhe-estandar-carta"
}
}
Ventana de terminal
redcumbre configuracion plantillas elegir --cuerpo @plantillas.json
redcumbre configuracion plantillas elegidas

Resultado esperado: la plantilla elegida por tipo de documento, con su detalle. Una plantilla que no existe responde 404; una que no está habilitada, que no corresponde al tipo de documento o que sólo se usa declarándola al emitir responde 400.

8. Revisa los topes de ValidaFirma y pide una ampliación

Sección titulada «8. Revisa los topes de ValidaFirma y pide una ampliación»
Ventana de terminal
redcumbre configuracion topes ver
redcumbre configuracion topes historial-de-proteccion --limite 20
redcumbre configuracion topes pedir-ampliacion --valor 200 --motivo "Subimos el volumen de firmas del mes"
{
"valor": 200,
"motivo": "Subimos el volumen de firmas del mes"
}

Resultado esperado: topes ver trae los topes vigentes de la empresa; historial-de-proteccion lista, paginado, los momentos en que la protección de topes actuó; pedir-ampliacion registra la solicitud. valor es un entero desde 1 y motivo tiene hasta 2.000 caracteres. La empresa tiene una solicitud pendiente a la vez: la segunda responde 409 hasta que la primera se resuelva.

9. Lee el registro de llamadas de las llaves

Sección titulada «9. Lee el registro de llamadas de las llaves»
Ventana de terminal
redcumbre configuracion llamadas listar --desde-fecha 2026-11-01T00:00:00Z --codigo 403
redcumbre configuracion llamadas listar --llave-id 12 --metodo POST --limite 50

Resultado esperado: { data, total, limit, offset }. Cada elemento de data trae exactamente id, ocurridaEn, metodo, ruta, codigoRespuesta, duracionMs, traceId, llave ({ id, nombre }) y error ({ codigo, mensajes }, o null si la llamada salió bien). El registro guarda los últimos 30 días; nunca trae el cuerpo de la llamada ni los secretos. Filtros: --desde-fecha y --hasta-fecha (ISO 8601), --codigo (100 a 599), --metodo, --ruta, --llave-id y --traza; --limite y --desde paginan.

Ventana de terminal
redcumbre configuracion suscripcion adicionales listar
redcumbre configuracion suscripcion adicionales ver <id-del-adicional>
redcumbre configuracion suscripcion plan
redcumbre configuracion suscripcion resumen

Resultado esperado:

  • Adicionales ({ data }): cada uno trae id, saas (codigo, nombre, origen), estado, plan (lagoPlanCode, nombre, cicloDeCobro, cuotaCents), periodo (desde y hasta, o null si está terminada), operacionProgramada (o null), contratadaEn, terminadaEn, silenciarCorreosAlCliente y alLlegarAlCupo. No trae identificadores del sistema de cobro.
  • Un adicional suma consumo por cupo, que es null cuando el sistema de cobro no responde, y consumoNoDisponible para decirlo. Un adicional que no es de la empresa responde 404.
  • El plan ({ success, data }): plan (code, nombre, interval, amountCents), consumoActual y consumoAnterior (cada uno con periodo y metricas) y sinServiciosActivos. Sin suscripción responde 400; si el sistema de cobro no responde, 502.
  • El resumen de pagos ({ success, data }): pendientes, vencidas, montoTotal, periodoMasAntiguo y nombreReseller.

Ninguna de las cuatro cobra ni cambia la suscripción: son de lectura.

Ventana de terminal
redcumbre configuracion pin listar
redcumbre configuracion pin crear --cuerpo @integracion.json
redcumbre configuracion pin actualizar <id-de-la-integracion> --cuerpo @cambios.json
redcumbre configuracion pin estadisticas <id-de-la-integracion> --periodo 7d
redcumbre configuracion pin desactivar <id-de-la-integracion>
redcumbre configuracion pin reactivar <id-de-la-integracion>
{
"slug": "tienda-ejemplo",
"name": "Tienda de ejemplo",
"defaultRedirectUri": "https://example.com/retorno",
"allowedRedirectUris": ["https://example.com/retorno"]
}
{
"name": "Tienda de ejemplo (nueva)"
}

Resultado esperado: una integración trae id, tenantId, slug, name, defaultRedirectUri, allowedRedirectUris, allowedCallbackUrls, active, createdAt, updatedAt y sharedPersonalData. El slug tiene de 2 a 50 caracteres (minúsculas, números, guion y guion bajo) y no se puede cambiar. Si pides compartir datos personales con sharedPersonalData y no declaras una dirección de aviso (allowedCallbackUrls), responde 400. desactivar no borra: deja active: false y reactivar la vuelve a dejar activa. estadisticas acepta 24h, 7d o 30d (por defecto 24h) y responde authorized, failed, expired, cancelled, pending y lastTransactionAt.

El canal es la vía por la que los asistentes de las personas operan en nombre de la empresa.

Ventana de terminal
redcumbre configuracion canal estado
redcumbre configuracion canal actividad --resultado rechazo --limite 50
redcumbre configuracion canal opciones-de-actividad
redcumbre configuracion canal conexiones
redcumbre configuracion canal hechos
redcumbre configuracion canal apagar
redcumbre configuracion canal prender
redcumbre configuracion canal quitar <id-de-la-conexion>

Resultado esperado:

  • Estado: apagado, desde, por y porCredencial.
  • Actividad ({ data, total, limit, offset }, ventana de 180 días): cada elemento trae id, ocurridaEn, persona ({ id, nombre } o null), asistente (nombre, verificado), herramienta, operacion, mutacion, resultado (exito, rechazo, fallo o desconocido), codigoRechazo y versionAutorizacion. Nunca trae el contenido de lo que el asistente pidió. Filtros: --desde-fecha, --hasta-fecha, --persona-id, --asistente, --herramienta, --resultado y --cliente-id.
  • Opciones de actividad: personas (id, nombre) y asistentes, para armar los filtros.
  • Conexiones ({ data }): conexionId, persona, propia, asistente (nombre, verificado, clientId, redirectUris) y constancias (id, version, aceptadaEn, revocadaEn, motivoRevocacion). Con una llave, propia es siempre false.
  • Hechos ({ data, total, limit, offset }): id, tipo, persona, porCredencial, ocurridoEn y conexion.
  • Apagar y prender responden el estado. Si el canal ya estaba en ese estado, responden 200 sin cambiar nada. Apagar revoca las autorizaciones vigentes y prender no las revive: cada persona tiene que volver a autorizar.
  • Quitar responde { quitada: true }. El conexionId es el identificador público de la conexión, el de conexiones.

Quién hizo qué. Lo que haces con una llave queda atribuido a la llave: apagar y prender dejan su nombre en porCredencial (con por en null), y los hechos del canal lo traen igual. Una persona con sesión sólo puede quitar sus propias conexiones; una llave puede quitar cualquier conexión vigente de la empresa. Una conexión de otra empresa, que no existe o que ya está quitada responde 404.

Ventana de terminal
redcumbre configuracion ventas casillas listar
redcumbre configuracion ventas casillas alertas
redcumbre configuracion ventas casillas tomar --parte-local ventas
redcumbre configuracion ventas casillas quitar <id-de-la-casilla>
{
"localPart": "ventas"
}

Resultado esperado: una casilla trae id, localPart, direccion, estado (ACTIVA o RESERVADA), tomadaAt, liberadaAt, reservadaHasta, usos (formaId, nombre, version, conBorrador) y alerta (causa y desde, o null). Las alertas traen casillaId, direccion, causa (FALLOS_SEGUIDOS, UNA_HORA o CASILLA_LIBERADA), desde y formasDeVenta. Para tomar una casilla manda sólo la parte local, sin el dominio. Si no está disponible responde 409. La casilla que tomas con una llave queda sin autor: la persona que la usa la ve igual. Quitar una casilla la deja reservada 180 días para la misma empresa; si la usa una forma de venta publicada, responde 409.

Ventana de terminal
redcumbre configuracion ventas campos listar --archivo VIGENTES --tipo TEXTO
redcumbre configuracion ventas campos crear --cuerpo @campo.json
redcumbre configuracion ventas campos ver <id-del-campo>
redcumbre configuracion ventas campos actualizar <id-del-campo> --cuerpo @cambios.json
redcumbre configuracion ventas campos archivar <id-del-campo>
{
"clave": "orden_de_compra",
"nombre": "Orden de compra",
"tipo": "TEXTO",
"obligatorio": false,
"visibilidad": "CLIENTE"
}
{
"nombre": "Número de orden de compra"
}

Resultado esperado: un campo trae id, clave, nombre, tipo (TEXTO, NUMERO, FECHA, LISTA o SI_NO), opciones, obligatorio, visibilidad (CLIENTE o INTERNO), destino, archivadoEn y formasQueLoUsan (id, nombre). El listado es { data, total, limit, offset } y filtra por --archivo (VIGENTES, ARCHIVADOS o TODOS), --tipo, --visibilidad y --busqueda. La clave son minúsculas, números y guion bajo, empieza con letra y no cambia después; un campo de tipo LISTA necesita opciones. Una clave repetida responde 409. El tipo no se cambia si el campo ya tiene valores. Archivar un campo que usa una forma de venta no archivada, o que ya está archivado, responde 409.

Ventana de terminal
redcumbre configuracion correo ver
redcumbre configuracion correo identidades listar
redcumbre configuracion correo identidades crear --cuerpo @identidad.json
redcumbre configuracion correo identidades verificar-conexion <id-de-la-identidad>
redcumbre configuracion correo identidades enviar-prueba <id-de-la-identidad> --a persona@example.com
redcumbre configuracion correo cambiar --cuerpo @correo.json
{
"defaultIdentityId": "identidad-de-ejemplo"
}
{
"to": "persona@example.com"
}

Resultado esperado:

  • Configuración (correo ver): id, tenantId, defaultIdentityId, creadoEn, actualizadoEn y creadoPorUserId, o null si la empresa no tiene. correo cambiar fija la identidad por defecto; con null la quita. Una identidad de otra empresa responde 400.
  • Identidad: id, tenantId, nombre, tipo (SIMPLE o SMTP_CUSTOM), fromName, fromEmail, replyTo, smtpHost, smtpPort, smtpUser, smtpSecure, smtpMaxConnections, smtpMaxPerHour, smtpMaxPerConnection, verificada, verificadaAt, activa, createdAt, updatedAt, createdByUserId y hasPassword. Sin smtpPassword.
  • Crear una identidad SMTP_CUSTOM exige fromName, fromEmail, smtpHost, smtpPort (1 a 65535), smtpUser y smtpPassword; el servidor tiene que ser público: uno interno responde 400. Actualizar acepta cualquier subconjunto de esos campos, más activa, y la contraseña sólo se guarda en una identidad SMTP_CUSTOM.
  • verificar-conexion responde { success, message }, con «Conexión exitosa» o un mensaje fijo según la causa de la falla. enviar-prueba responde { success, message } y envía un correo real a la dirección --a.
  • quitar responde { success: true, message }; una identidad que no existe o es de otra empresa responde 404.

Lo que escribes en el correo y en el PIN con una llave queda atribuido a esa llave (llave:<id>) en el registro de actividad, no a una persona.

Ventana de terminal
redcumbre configuracion plantillas correo listar
redcumbre configuracion plantillas correo asignaciones --proceso DTE_ENVIO
redcumbre configuracion plantillas correo contenido-por-defecto --proceso DTE_ENVIO
redcumbre configuracion plantillas correo crear --cuerpo @plantilla.json
redcumbre configuracion plantillas correo vista-previa <id-de-la-plantilla>
redcumbre configuracion plantillas correo actualizar <id-de-la-plantilla> --cuerpo @cambios.json
redcumbre configuracion plantillas correo quitar <id-de-la-plantilla>
{
"nombre": "Envío de factura",
"procesoTipo": "DTE_ENVIO",
"subject": "Tu documento {{folio}}",
"htmlContent": "<p>Hola, te enviamos tu documento.</p>",
"adjuntarPdf": true,
"subTipos": ["33"]
}
{
"activo": true
}

Resultado esperado:

  • Plantilla: id, tenantId, nombre, procesoTipo (DTE_ENVIO o DTE_VENCIMIENTO), modoEdicion (VISUAL o AVANZADO), subject, htmlContent, identityId, activo, adjuntarPdf, createdAt, updatedAt y createdByUserId; el listado y el detalle suman la identidad (id, nombre, tipo, activa) y las asignaciones por subtipo.
  • Crear y actualizar responden { template, warnings }: warnings avisa de las variables del texto que el sistema no conoce. Un subtipo tiene una sola plantilla activa por proceso; repetirlo responde 409. No se puede volver de AVANZADO a VISUAL.
  • Asignaciones: por cada subtipo del proceso, subTipo, asignado y template (id, nombre, activo, o null).
  • Contenido por defecto: html y subject del sistema. --proceso es obligatorio; uno que no existe responde 400.
  • Vista previa: html, subject, identity y isExample. Sin --dte-id se arma con datos de ejemplo (isExample: true); con un documento de la empresa, con sus datos.
  • Quitar responde { deleted: true }; una plantilla que no existe o es de otra empresa responde 404.
RespuestaQué significaQué haces
400Un campo que la operación no declara, un modo fuera del catálogo, una caché menor a 1, una información de pago de más de 500 caracteres o una plantilla que no correspondeCorrige el cuerpo y repite
404Eliminar una configuración, un logo, una identidad o una plantilla de correo que no existe; un adicional o una conexión que no es de la empresa; una plantilla fuera del catálogoVerifica con la operación de lectura
409Crear la configuración de ValidaFirma cuando ya existe, una segunda solicitud de tope pendiente, una casilla o una clave de campo repetida, archivar un campo o quitar una casilla que una forma de venta usa, o una plantilla de correo activa repetida para un subtipoUsa la operación de actualizar, espera a que se resuelva la pendiente o libera el recurso que lo usa
502El sistema de cobro no responde al leer el planRepite más tarde