API de actualización de QR
Permite actualizar la configuración y el diseño de un código QR existente.
Puedes modificar la URL, el texto o el número de teléfono, así como colores, estilos, logotipos y otras opciones. El código QR se actualiza directamente sin necesidad de recrearlo.
Utiliza esta API cuando necesites cambiar la configuración sin generar un nuevo QR.
/api/link/v1/update/qr
{
"linkId": "K56t",
"domain": "https://vvd.bz",
"type": "url",
"url": "https://www.instagram.com/vivoldiglobal",
"logoType": "U",
"logo": "https://example.com/images/picture/logo/20260425/500x500.png",
"foreground": "#0269D1FF"
}
Request Parameters
- linkId string required
-
ID del enlace.
Si la URL es “https://vvd.im/myBrandQR”, el ID del enlace es
myBrandQR. - domain string required
- Default:https://vvd.bz
- Dominio del enlace. Si utilizas un dominio personalizado, puedes especificarlo aquí.
- type string
-
Enum:
urltextphoneemailsmswifi
-
Tipo de contenido del QR.
- url: URL de página web
- text: Texto plano
- phone: Número de teléfono
- email: Correo electrónico (destinatario, asunto, cuerpo)
- sms: SMS (número del destinatario, mensaje)
- wifi: Acceso Wi-Fi (nombre de red, seguridad, contraseña)
Si omite
type, se mantiene el tipo actual. Solo al cambiartypea otro tipo debe enviar también el campo obligatorio del nuevo tipo; si es el mismo tipo, envíe solo los campos que quiera cambiar. Los campos que no envíe conservan su valor actual. Los nombres anterioresqrEml,qrEmlTtl,qrEmlBody,qrSmsPhnNo,qrSmsBody,qrWifiSsid,qrWifiEncrypt,qrWifiPwdse siguen aceptando, pero están obsoletos. Cámbielos por los nombres de arriba. Si envía el mismo campo con ambos nombres, se devuelve un error 400. - url string
-
URL de destino al escanear el QR.
Obligatorio cuando
typeesurl. Debe ser una URL completa con http o https.
Máximo:2,000 bytes.
En una actualización, solo es obligatorio al cambiar a ese tipo; si el tipo no cambia, puede omitirlo (se conserva el valor actual). - text string
-
Contenido de texto dentro del QR.
Se usa cuando
typeestexty se muestra tal cual al escanear.
Útil para mensajes, códigos o instrucciones. La visualización puede variar según el dispositivo.
Máximo:65,535 bytes. - phone string
-
Número de teléfono al escanear el QR.
Se usa cuando
typeesphone. Abre la app de llamadas.
Máximo:32 caracteres. Se recomienda incluir el código de país.
Cuandotypeessms, es el número del destinatario del mensaje y es obligatorio. Los guiones (-) se eliminan al guardar.
En una actualización, solo es obligatorio al cambiar a ese tipo; si el tipo no cambia, puede omitirlo (se conserva el valor actual). - email string
-
Dirección del destinatario del correo que se redacta al escanear.
Obligatorio cuandotypeesemail. Longitud máxima:128 caracteres.
En una actualización, solo es obligatorio al cambiar a ese tipo; si el tipo no cambia, puede omitirlo (se conserva el valor actual). - emailSubject string
-
Asunto del correo. Se usa cuando
typeesemail. Longitud máxima:256 caracteres. En una actualización, enviar una cadena vacía borra el valor. - emailBody string
-
Cuerpo del correo. Se usa cuando
typeesemail. Longitud máxima:65,535 bytes. En una actualización, enviar una cadena vacía borra el valor. - message string
-
Contenido del mensaje. Se usa cuando
typeessms; envíe el número del destinatario enphone.
Longitud máxima:128 caracteres. En una actualización, enviar una cadena vacía borra el valor. - wifiSsid string
-
Nombre de la red Wi-Fi (SSID). Obligatorio cuando
typeeswifi. Longitud máxima:64 caracteres.
En una actualización, solo es obligatorio al cambiar a ese tipo; si el tipo no cambia, puede omitirlo (se conserva el valor actual). - wifiEncryption string
-
Enum:
WPAWEPnopass
-
Tipo de seguridad Wi-Fi. Se usa cuando
typeeswifi.- WPA: WPA/WPA2/WPA3
- WEP: WEP
- nopass: Sin contraseña
wifi, si se omite se usaWPA; si el tipo ya eswifi, se conserva el valor actual. - wifiPassword string
-
Contraseña Wi-Fi. Se usa cuando
typeeswifi; los espacios al inicio y al final se eliminan al guardar.
Longitud máxima:32 caracteres. Déjela vacía si la seguridad esnopass. En una actualización, enviar una cadena vacía borra el valor. - logoType string
- Default:N
-
Enum:
NCU
-
Tipo de logo en el centro del QR.
- N: Sin logo
- C: Logo por defecto de la organización
- U: Logo personalizado
Agregar un logo mejora el reconocimiento de marca.
Disponible desde el plan Personal. - logo string
-
URL de la imagen del logo.
Se usa cuando
logoTypeesU. Debe ser accesible públicamente.
Se recomienda formato cuadrado y PNG transparente. Máx: 500x500 px. - foreground string
-
Color principal del QR (HEX). Por defecto negro.
Mantén alto contraste con el fondo.
Default: #000000FF - background string
-
Color de fondo (HEX). Por defecto blanco.
Fondos oscuros pueden reducir la lectura.
Default: #FFFFFFFF - markerColor string
-
Color de los marcadores del QR.
Default: #000000FF - markerBorderColor string
-
Color del borde de los marcadores.
Default: #000000FF - style string
- Estilo visual del QR. Consulta el dashboard para ejemplos.
- markerStyle string
- Estilo de los marcadores. Compatible con múltiples formas.
- grpIdx integer
- ID de grupo para organización de enlaces.
- ttl string
- Título interno del enlace.
- memo string
- Nota interna no visible para usuarios.
- qrBypassYn string
-
Y: acceso directo (sin tracking)
N: vía short link (con tracking) - pushNotifyYn string
- Notificaciones push al escanear.
- mailNotifyYn string
- Notificaciones por email al escanear.
- delYmdt datetime
- Fecha de eliminación automática.
{
"code": 0,
"message": "",
"result": null
}
Response Parameters
- code integer
- Código de respuesta: 0 = Éxito, otros valores = Error
- message string
- Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje de error.
- result null
Cuándo usar esta API
Utiliza la API de actualización de QR en los siguientes casos:
- Cuando necesitas cambiar la URL de destino de un QR ya distribuido
- Cuando quieres actualizar el diseño, como colores, logotipos o estilos
- Cuando necesitas modificar el contenido o la configuración sin eliminar el QR
- Cuando necesitas actualizar el diseño de QR a gran escala, por ejemplo, en un cambio de marca
por lo que puedes actualizar el contenido sin reemplazar los códigos ya impresos o usados en materiales offline.
Casos de uso
La API de actualización de QR es útil en distintos escenarios:
- Materiales impresos y banners: Cambia solo la URL de destino de QR ya distribuidos y evita costes de reimpresión
- Renovación de marca: Actualiza en bloque el diseño de los QR según los nuevos colores de marca
- Gestión de eventos: Cambia las páginas de destino por temporada sin modificar el QR
- Tiendas y mesas: Redirige los QR existentes a nuevas páginas de menú cuando cambian
Especialmente útil cuando necesitas reutilizar códigos QR ya distribuidos.
Aspectos a tener en cuenta
Ten en cuenta lo siguiente al actualizar un código QR:
-
Actualiza
foreground(color principal) ybackground(color de fondo) juntos.
Cambiar solo el fondo puede reducir la precisión de lectura por falta de contraste. -
Utiliza un
backgroundclaro, como #FFFFFF (blanco).
Los fondos oscuros pueden dificultar la detección del patrón QR. - Al cambiar
type, proporciona el parámetro de datos correspondiente. - Al cambiar el grupo con
grpIdx, el QR se mueve al nuevo grupo y se elimina del anterior.