Stamp Creation API

Stamp Creation API allows you to issue new stamps to customers programmatically.

Provide the Card IDX and expiration date to add a stamp to the selected stamp card. You can also store user information and notes together to manage each customer’s stamp history in a structured way.
The Card IDX is available on the “Stamp Cards” page in your dashboard.

This API is available on the Personal plan or higher.

POST

/api/stamp/v1/create

{
    "cardIdx": 123,  // You can check the IDX value on the card management page of the dashboard.
    "domain": "https://vvd.bz",
    "strtYmd": "2025-01-01",
    "endYmd": "2025-12-31",
    "activeYn": "Y",
    "memo": "New Member Registration, IP: 211.111.222.33",
    "userId": "att78z",
    "userNm": "Brown Smith",
    "userPhnno": "+1 123-4567-8900",
    "userEml": "test@gmail.com",
    "userEtc1": "Gold rating",
    "userEtc2": ""
}

Request Parameters

cardIdx integer required
Card IDX.
The Card IDX can be found on the “Stamp Card” page in the dashboard.
domain string
Default:https://vvd.bz
Stamp domain.
If left empty, it will be saved using the default domain.
Available for Premium plans or higher — you can specify a custom domain registered in the Link Domain Management section.
strtYmd date required
Stamp validity start date. Example: 2025-01-01
endYmd date required
Stamp validity end date. Example: 2025-12-31
The expiration date can be set up to 5 years from today.
activeYn string
Default:Y
Enum:
YN
Stamp activation status.
If deactivated, customers will not be able to use the stamp.
memo string
Internal memo for reference.
userId string
User ID.
Used to manage the recipient of the stamp issuance.
Typically, enter the login ID of a website member.
If not specified, the system will automatically generate a user ID.
userNm string
User name. For internal management.
userPhnno string
User contact number. For internal management.
userEml string
User email address. For internal management.
userEtc1 string
Additional internal management field.
userEtc2 string
Additional internal management field.
{
    "code": 0,
    "message": "",
    "result": 1347
}

Response Parameters

code integer
Response code: 0 = Success, other values = Error
message string
Response message. If the response code is not 0, an error message is returned.
result integer
Response value. The generated Stamp IDX will be returned.
Example: 1347

When to Use This API

Use this API to build stamp-based campaigns and reward systems.

  • Visit-based reward campaigns
  • In-store stamp collection programs
  • User activity verification systems
  • Tracking specific actions (purchases, participation, etc.)

Best suited for tracking user actions and converting them into rewards.

Relationship Between Stamp Cards and Stamps

A stamp card defines the campaign rules and layout, while stamps are the units issued to users.

When calling the creation API, specify cardIdx to determine which card the stamp will be issued to.

The Card IDX is available in the dashboard. Each card has its own conditions and rewards, so selecting the correct card is critical.

Stamp Creation Structure and Components

A stamp is not just a data record. It represents a unit of user activity.

Key components:

  • Card identifier (cardIdx) : ID of the card the stamp belongs to
  • Validity period (strtYmd, endYmd) : Time range when the stamp is valid
  • Status (activeYn) : Indicates whether the stamp is active and usable
  • User information (userId, userNm, userEmail, etc.) : Target user
  • Additional fields (memo, userEtc1, userEtc2) : Custom data

This structure allows you to track and manage user activity with a high level of personalization.

User Data Integration

The userId field identifies and manages the stamp recipient.

Typically, you should pass your internal user ID. If omitted, the system automatically generates one.

By including fields such as userNm, userPhnno, and userEml, you can store contact details and track stamp activity per user directly from the dashboard.

Use cases

  • Welcome stamp on signup: Automatically issue a welcome stamp when a user completes registration by calling the API
  • Automated purchase rewards: Trigger the stamp creation API after payment completion to award stamps based on purchase count
  • Limited-time campaigns: Issue stamps valid only within a defined period using strtYmd·endYmd
  • Event participation tracking: Create stamps when users join events to track participation history
  • Reward campaign management: Grant coupons or benefits based on accumulated stamps

Difference from Coupon API

Both the Coupon API and the Stamp API are used in marketing, but they serve different purposes and workflows.

The Coupon API is conversion-focused, driving immediate purchases through discounts.
In contrast, the Stamp API is retention-focused, tracking user behavior and encouraging repeat engagement.

1. Purpose

  • Coupon API → Discounts → Drive purchases (Conversion)
  • Stamp API → Behavior tracking → Encourage repeat visits (Retention)

Coupons are effective for short-term revenue, while stamps are better suited for long-term engagement and retention.

2. Timing of Use

  • Coupon → Used before or during checkout
  • Stamp → Issued when user actions occur (visits, participation, etc.)

Coupons push users to complete a purchase now, while stamps encourage the next action.

3. Data Structure

Coupons are event-based.

  • Single-use or limited usage
  • Focused on discount value or rate
  • Consumed or updated immediately upon use

Stamps are accumulation-based.

  • Can be issued repeatedly
  • Track cumulative data per user
  • Trigger rewards when conditions are met

In short, coupons are one-time triggers, while stamps are accumulated state data.

4. Marketing Strategy

Coupon-based strategy:

  • Acquire new users
  • Increase conversion rates
  • Promote specific products

Stamp-based strategy:

  • Encourage repeat visits
  • Build customer loyalty
  • Run long-term campaigns

5. Combined Usage

In practice, both APIs are often used together.

Example:

  • Accumulate stamps (e.g., 10 visits)
  • Automatically issue a coupon when conditions are met
  • Drive purchases using the coupon

This flow connects Engagement → Retention → Conversion into a single lifecycle.

Things to consider

  • cardIdx must reference a valid card ID
  • Define a clear policy for duplicate stamps per user
  • Incorrect validity periods can impact campaign performance