Edit Cap

API ini digunakan untuk memperbarui informasi cap yang sudah dibuat.

Anda dapat mengubah jumlah cap yang dikumpulkan (stamps), status penggunaan manfaat (useYn), dan opsi reset PIN (resetPinYn).

API ini tersedia untuk paket Personal dan yang lebih tinggi.

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.
Card IDX dapat ditemukan di halaman “Kartu Cap” pada dasbor.
stampsinteger
Menentukan jumlah cap yang telah dikumpulkan.
Menunjukkan total jumlah cap yang telah diperoleh pelanggan. Mengubah nilai ini akan memperbarui status cap dan dapat ditambah atau dikurangi.
Jika semua cap sudah terkumpul (stamps = jumlah maksimum cap pada kartu), Anda harus mengatur useYn ke Y untuk menandai bahwa hadiah telah digunakan.
resetPinYnstring
Default:N
Enum:
YN
Menentukan apakah PIN pelanggan untuk cap akan diatur ulang.
Y: Mengatur ulang PIN pelanggan yang sudah ada. Setelah diatur ulang, pelanggan harus membuat PIN baru saat mengakses halaman cap berikutnya.
N: Menjaga PIN yang ada tanpa perubahan.
useYnstring
Default:N
Enum:
YN
Menentukan apakah hadiah dari cap telah digunakan.
Y: Pelanggan telah mengumpulkan semua cap dan menukarkan hadiah (misalnya minuman gratis, diskon, dll). Setelah penukaran, cap menjadi tidak aktif dan cap baru harus diterbitkan.
N: Hadiah belum digunakan.
domainstring
Default:https://vvd.bz
Domain cap.
Jika dikosongkan, domain default akan digunakan.
Tersedia untuk paket Premium ke atas — Anda dapat menentukan domain kustom yang terdaftar di bagian Manajemen Domain Tautan.
strtYmddate
Tanggal mulai berlaku cap. Contoh: 2025-01-01
endYmddate
Tanggal kedaluwarsa cap. Contoh: 2025-12-31
Tanggal kedaluwarsa dapat diatur hingga maksimal 5 tahun dari hari ini.
activeYnstring
Default:Y
Enum:
YN
Menunjukkan apakah cap aktif. Jika dinonaktifkan, pelanggan tidak dapat menggunakan cap tersebut.
memostring
Catatan internal untuk referensi.
userIdstring
ID pengguna. Digunakan untuk mengelola penerima cap.
Biasanya diisi dengan ID login anggota situs web.
Jika tidak ditentukan, sistem akan secara otomatis membuat ID pengguna.
userNmstring
Nama pengguna. Hanya untuk penggunaan internal.
userPhnnostring
Nomor kontak pengguna. Hanya untuk penggunaan internal.
userEmlstring
Alamat email pengguna. Hanya untuk penggunaan internal.
userEtc1string
Bidang tambahan untuk pengelolaan internal.
userEtc2string
Bidang tambahan untuk pengelolaan internal. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger
Kode respons: 0 = Berhasil, nilai lainnya = Error
messagestring
Pesan respons. Jika kode bukan 0, pesan error akan dikembalikan.
resultnull