Editar Sello

Esta API permite modificar la información de un sello existente.

Puedes actualizar los datos como la cantidad de sellos acumulados (stamps), el estado de uso de beneficios (useYn) y la opción de restablecer el PIN (resetPinYn).

Esta API está disponible en el plan Personal o superior.

PUT

/api/stamp/v1/update

{
    "stampIdx": 1457,
    "cardIdx": 172,
    "stamps": 7,
    "resetPinYn": "Y",
    "userEml": "example@gmail.com"
}

Request Parameters

stampIdxintegerrequired
Stamp IDX.
cardIdxinteger
Card IDX.
El Card IDX puede consultarse en la página «Tarjeta de Sellos» del panel de control.
stampsinteger
Especifica el número de sellos acumulados.
Representa el total de sellos que el cliente ha reunido. Al modificar este valor, se actualizará el progreso de sellos y se puede aumentar o disminuir.
Cuando se completan todos los sellos (stamps = número máximo de sellos en la tarjeta), debes establecer useYn en Y para marcar el sello como canjeado.
resetPinYnstring
Default:N
Enum:
YN
Indica si se debe restablecer el PIN del cliente para el sello.
Y: Restablece el PIN establecido por el cliente. Después del restablecimiento, el cliente deberá definir un nuevo PIN al volver a acceder a la página del sello.
N: Mantiene el PIN actual sin cambios.
useYnstring
Default:N
Enum:
YN
Indica si el cliente ha utilizado la recompensa del sello.
Y: El cliente ha reunido todos los sellos y ha canjeado una recompensa (por ejemplo, bebida gratis, descuento, etc.). Después del canje, el sello se desactiva y se debe emitir uno nuevo.
N: La recompensa aún no ha sido utilizada.
domainstring
Default:https://vvd.bz
Dominio del sello.
Si está vacío, se utilizará el dominio predeterminado.
Disponible para planes Premium o superiores — puedes especificar un dominio personalizado registrado en la sección de Gestión de Dominios de Enlaces.
strtYmddate
Fecha de inicio de validez del sello. Ejemplo: 2025-01-01
endYmddate
Fecha de caducidad del sello. Ejemplo: 2025-12-31
La fecha de caducidad puede configurarse hasta 5 años desde la fecha actual.
activeYnstring
Default:Y
Enum:
YN
Estado de activación del sello. Si está desactivado, los clientes no podrán usar el sello.
memostring
Nota interna de referencia.
userIdstring
ID del usuario. Se utiliza para gestionar al destinatario del sello.
Normalmente, introduce el ID de inicio de sesión del miembro del sitio web.
Si no se especifica, el sistema generará automáticamente un ID de usuario.
userNmstring
Nombre del usuario. Solo para uso interno.
userPhnnostring
Número de contacto del usuario. Solo para uso interno.
userEmlstring
Correo electrónico del usuario. Solo para uso interno.
userEtc1string
Campo adicional para gestión interna.
userEtc2string
Campo adicional para gestión interna.
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger
Código de respuesta: 0 = Éxito, otros valores = Error
messagestring
Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje de error.
resultnull