Langsung ke konten utama
POST
/
instances
/
{instanceId}
/
coupon-schedules
Buat jadwal kupon
curl --request POST \
  --url https://api.altostrat.io/instances/{instanceId}/coupon-schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Tiket Tamu Harian",
  "count": 20,
  "recurrence_type": "daily",
  "day_of_week": 1,
  "day_of_month": 15,
  "valid_for_in_minutes": 480,
  "timezone": "Australia/Sydney",
  "notification_group_id": "ng_a1b2c3d4e5f6"
}'
{
  "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "name": "Tiket Tamu Harian",
  "instance_id": "9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "count": 20,
  "recurrence_type": "daily",
  "day_of_week": 1,
  "day_of_month": 15,
  "valid_for_in_minutes": 480,
  "timezone": "Australia/Sydney",
  "notification_group_id": "ng_a1b2c3d4e5f6",
  "last_run_at": "2025-10-29T08:00:00Z",
  "next_run_at": "2025-10-30T08:00:00Z",
  "tokens_used_since_last_run": 5,
  "tokens_generated_since_last_run": 20,
  "tokens_available_since_last_run": 15,
  "created_at": "2025-10-20T14:30:00Z"
}

Authorizations

Authorization
string
header
required

Autentikasi Kunci API. Sediakan token Anda di header 'Authorization'. Contoh: Authorization: Bearer <TOKEN_ANDA>

Path Parameters

instanceId
string<uuid>
required

Pengidentifikasi unik untuk instance captive portal.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

Body

application/json
name
string
required

Nama yang mudah dibaca untuk jadwal.

Example:

"Tiket Tamu Harian"

count
integer
required

Jumlah kupon yang akan dihasilkan setiap kali jadwal berjalan.

Required range: 1 <= x <= 500
Example:

20

recurrence_type
enum<string>
required

Seberapa sering jadwal harus berjalan.

Opsi yang tersedia:
daily,
weekly,
monthly
Example:

"daily"

valid_for_in_minutes
integer
required

Jumlah menit setiap kupon yang dihasilkan akan valid.

Required range: 1 <= x <= 90000
Example:

480

timezone
string
required

Zona waktu di mana jadwal harus dievaluasi (misalnya, 'America/New_York').

Example:

"Australia/Sydney"

notification_group_id
string
required

ID dari grup notifikasi untuk menerima kupon yang dihasilkan.

Example:

"ng_a1b2c3d4e5f6"

day_of_week
integer | null

Diperlukan untuk pengulangan 'weekly'. Hari dalam seminggu untuk berjalan (0=Minggu, 6=Sabtu).

Required range: 0 <= x <= 6
Example:

1

day_of_month
integer | null

Diperlukan untuk pengulangan 'monthly'. Tanggal dalam bulan untuk berjalan (1-31).

Required range: 1 <= x <= 31
Example:

15

Response

Jadwal kupon berhasil dibuat.

id
string<uuid>

Pengidentifikasi unik untuk jadwal kupon.

Example:

"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

name
string

Nama yang mudah dibaca untuk jadwal.

Example:

"Tiket Tamu Harian"

instance_id
string<uuid>

ID dari instance tempat jadwal ini berada.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

count
integer

Jumlah kupon yang akan dihasilkan setiap kali jadwal berjalan.

Example:

20

recurrence_type
enum<string>

Seberapa sering jadwal harus berjalan.

Opsi yang tersedia:
daily,
weekly,
monthly
Example:

"daily"

day_of_week
integer | null

Diperlukan untuk pengulangan 'weekly'. Hari dalam seminggu untuk berjalan (0=Minggu, 6=Sabtu).

Example:

1

day_of_month
integer | null

Diperlukan untuk pengulangan 'monthly'. Tanggal dalam bulan untuk berjalan (1-31).

Example:

15

valid_for_in_minutes
integer

Jumlah menit setiap kupon yang dihasilkan akan valid setelah pembuatannya.

Example:

480

timezone
string

Zona waktu di mana jadwal harus dievaluasi (misalnya, 'America/New_York').

Example:

"Australia/Sydney"

notification_group_id
string

ID dari grup notifikasi untuk menerima kupon yang dihasilkan.

Example:

"ng_a1b2c3d4e5f6"

last_run_at
string<date-time> | null

Stempel waktu terakhir kali jadwal ini berhasil dijalankan.

Example:

"2025-10-29T08:00:00Z"

next_run_at
string<date-time> | null

Stempel waktu yang dihitung dari jadwal berjalan berikutnya.

Example:

"2025-10-30T08:00:00Z"

tokens_used_since_last_run
integer

Jumlah kupon dari proses terakhir yang telah ditukarkan.

Example:

5

tokens_generated_since_last_run
integer

Jumlah total kupon yang dihasilkan dalam proses terakhir.

Example:

20

tokens_available_since_last_run
integer

Jumlah kupon yang valid dan belum ditukarkan yang tersisa dari proses terakhir.

Example:

15

created_at
string<date-time>

Stempel waktu saat jadwal dibuat.

Example:

"2025-10-20T14:30:00Z"