Edit Stamp

This API allows you to modify existing stamp information.

You can update details such as the customer’s collected stamps (stamps), benefit usage status (useYn), and PIN reset option (resetPinYn).

This API is available for Personal plans and higher.

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.
The Card IDX can be found on the “Stamp Card” page in the dashboard.
stampsinteger
Specifies the number of collected stamps.
Represents the total number of stamps the customer has collected. Updating this value refreshes the stamp progress and can either increase or decrease it.
When all stamps are collected (stamps = the card’s maximum stamp count), you must set useYn to Y to mark the stamp as redeemed.
resetPinYnstring
Default:N
Enum:
YN
Determines whether to reset the customer’s PIN code for the stamp.
Y: Resets the customer’s existing PIN. After reset, the customer must set a new PIN upon the next visit to the stamp page.
N: Keeps the current PIN unchanged.
useYnstring
Default:N
Enum:
YN
Specifies whether the customer has used the stamp reward.
Y: The customer has collected all stamps and redeemed a reward (e.g., free drink, discount, etc.). After redemption, the stamp becomes inactive and a new one must be issued.
N: The reward has not been used yet.
domainstring
Default:https://vvd.bz
Stamp domain.
If empty, the default domain will be used.
Available for Premium plans or higher — you can specify a custom domain registered in the Link Domain Management section.
strtYmddate
Stamp start date. Example: 2025-01-01
endYmddate
Stamp expiration date. Example: 2025-12-31
The expiration date can be set up to 5 years from today.
activeYnstring
Default:Y
Enum:
YN
Indicates whether the stamp is active. If disabled, the customer cannot use the stamp.
memostring
Internal memo for reference.
userIdstring
User ID. Used to manage the stamp recipient.
Typically, enter the website member’s login ID.
If not specified, a unique user ID is automatically generated by the system.
userNmstring
User name. For internal use only.
userPhnnostring
User contact number. For internal use only.
userEmlstring
User email address. For internal use only.
userEtc1string
Additional internal field for management purposes.
userEtc2string
Additional internal field for management purposes.
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger
Response code: 0 = Success, other values = Error
messagestring
Response message. If the response code is not 0, an error message is returned.
resultnull