Stempel Bearbeiten

Diese API ermöglicht das Bearbeiten von bestehenden Stempelinformationen.

Sie können Daten wie die Anzahl der gesammelten Stempel (stamps), den Belohnungsstatus (useYn) und die PIN-Zurücksetzungsoption (resetPinYn) ändern.

Diese API ist ab dem Personal-Tarif und höher verfügbar.

PUT

/api/stamp/v1/update

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

Request Parameters

stampIdxintegerrequired
Stempel-IDX.
cardIdxinteger
Karten-IDX.
Die Karten-IDX kann auf der Seite „Stempelkarte“ im Dashboard eingesehen werden.
stampsinteger
Gibt die Anzahl der gesammelten Stempel an.
Zeigt die Gesamtzahl der Stempel, die der Kunde gesammelt hat. Durch das Ändern dieses Wertes wird der Stempelstatus aktualisiert; sowohl Erhöhungen als auch Verringerungen sind möglich.
Wenn alle Stempel gesammelt wurden (stamps = maximale Stempelanzahl der Karte), muss useYn auf Y gesetzt werden, um den Stempel als eingelöst zu markieren.
resetPinYnstring
Default:N
Enum:
YN
Legt fest, ob die PIN des Kunden für den Stempel zurückgesetzt werden soll.
Y: Setzt die vom Kunden festgelegte PIN zurück. Nach dem Zurücksetzen muss der Kunde beim nächsten Aufruf der Stempelseite eine neue PIN festlegen.
N: Behält die aktuelle PIN bei.
useYnstring
Default:N
Enum:
YN
Gibt an, ob der Kunde die Stempelbelohnung verwendet hat.
Y: Der Kunde hat alle Stempel gesammelt und eine Belohnung eingelöst (z. B. kostenloses Getränk, Rabatt usw.). Nach der Einlösung wird der Stempel deaktiviert und ein neuer muss ausgegeben werden.
N: Die Belohnung wurde noch nicht eingelöst.
domainstring
Default:https://vvd.bz
Stempel-Domain.
Wenn kein Wert angegeben wird, wird die Standarddomain verwendet.
Verfügbar für Premium-Tarife oder höher — Sie können eine benutzerdefinierte Domain angeben, die im Bereich „Link-Domain-Verwaltung“ registriert ist.
strtYmddate
Startdatum der Stempelgültigkeit. Beispiel: 2025-01-01
endYmddate
Ablaufdatum des Stempels. Beispiel: 2025-12-31
Das Ablaufdatum kann bis zu 5 Jahre ab dem heutigen Datum festgelegt werden.
activeYnstring
Default:Y
Enum:
YN
Gibt an, ob der Stempel aktiv ist. Wenn deaktiviert, kann der Kunde den Stempel nicht verwenden.
memostring
Interne Notiz zu Referenzzwecken.
userIdstring
Benutzer-ID. Wird verwendet, um den Empfänger des Stempels zu verwalten.
Normalerweise geben Sie die Login-ID des Website-Mitglieds ein.
Wenn kein Wert angegeben wird, generiert das System automatisch eine Benutzer-ID.
userNmstring
Benutzername. Nur für interne Verwendung.
userPhnnostring
Telefonnummer des Benutzers. Nur für interne Verwendung.
userEmlstring
E-Mail-Adresse des Benutzers. Nur für interne Verwendung.
userEtc1string
Zusätzliches Feld für interne Verwaltung.
userEtc2string
Zusätzliches Feld für interne Verwaltung.
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger
Antwortcode: 0 = Erfolg, andere Werte = Fehler
messagestring
Antwortnachricht. Wenn der Code nicht 0 ist, wird eine Fehlermeldung zurückgegeben.
resultnull