Saltar al contenido principal
POST
/
instances
/
{instanceId}
/
coupon-schedules
Crear una programación de cupones
curl --request POST \
  --url https://api.altostrat.io/instances/{instanceId}/coupon-schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Pases Diarios de Invitados",
  "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": "Pases Diarios de Invitados",
  "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

Autenticación por Clave de API. Proporcione su token en la cabecera 'Authorization'. Ejemplo: Authorization: Bearer <SU_TOKEN>

Path Parameters

​
instanceId
string<uuid>
required

El identificador único para la instancia del portal cautivo.

Example:

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

Body

application/json
​
name
string
required

Un nombre legible para la programación.

Example:

"Pases Diarios de Invitados"

​
count
integer
required

El número de cupones a generar cada vez que se ejecuta la programación.

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

20

​
recurrence_type
enum<string>
required

La frecuencia con la que se debe ejecutar la programación.

Opciones disponibles:
daily,
weekly,
monthly
Example:

"daily"

​
valid_for_in_minutes
integer
required

El número de minutos que cada cupón generado será válido.

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

480

​
timezone
string
required

La zona horaria en la que se debe evaluar la programación (p. ej., 'America/New_York').

Example:

"Australia/Sydney"

​
notification_group_id
string
required

El ID de un grupo de notificación para recibir los cupones generados.

Example:

"ng_a1b2c3d4e5f6"

​
day_of_week
integer | null

Requerido para la recurrencia 'weekly' (semanal). El día de la semana para ejecutar (0=Domingo, 6=Sábado).

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

1

​
day_of_month
integer | null

Requerido para la recurrencia 'monthly' (mensual). El día del mes para ejecutar (1-31).

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

15

Response

La programación de cupones se creó correctamente.

​
id
string<uuid>

El identificador único para la programación de cupones.

Example:

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

​
name
string

Un nombre legible para la programación.

Example:

"Pases Diarios de Invitados"

​
instance_id
string<uuid>

El ID de la instancia a la que pertenece esta programación.

Example:

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

​
count
integer

El número de cupones a generar cada vez que se ejecuta la programación.

Example:

20

​
recurrence_type
enum<string>

La frecuencia con la que se debe ejecutar la programación.

Opciones disponibles:
daily,
weekly,
monthly
Example:

"daily"

​
day_of_week
integer | null

Requerido para la recurrencia 'weekly' (semanal). El día de la semana para ejecutar (0=Domingo, 6=Sábado).

Example:

1

​
day_of_month
integer | null

Requerido para la recurrencia 'monthly' (mensual). El día del mes para ejecutar (1-31).

Example:

15

​
valid_for_in_minutes
integer

El número de minutos que cada cupón generado será válido después de su creación.

Example:

480

​
timezone
string

La zona horaria en la que se debe evaluar la programación (p. ej., 'America/New_York').

Example:

"Australia/Sydney"

​
notification_group_id
string

El ID de un grupo de notificación para recibir los cupones generados.

Example:

"ng_a1b2c3d4e5f6"

​
last_run_at
string<date-time> | null

La marca de tiempo de la última vez que esta programación se ejecutó con éxito.

Example:

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

​
next_run_at
string<date-time> | null

La marca de tiempo calculada de la próxima ejecución programada.

Example:

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

​
tokens_used_since_last_run
integer

El número de cupones de la última ejecución que han sido canjeados.

Example:

5

​
tokens_generated_since_last_run
integer

El número total de cupones generados en la última ejecución.

Example:

20

​
tokens_available_since_last_run
integer

El número de cupones válidos y no canjeados que quedan de la última ejecución.

Example:

15

​
created_at
string<date-time>

La marca de tiempo de cuándo se creó la programación.

Example:

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