Pular para o conteúdo principal
PUT
/
instances
/
{instanceId}
/
coupon-schedules
/
{scheduleId}
Atualizar um agendamento de cupons
curl --request PUT \
  --url https://api.altostrat.io/instances/{instanceId}/coupon-schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Passes Diários para Convidados",
  "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": "Passes Diários para Convidados",
  "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

Autenticação por Chave de API (API Key). Forneça seu token no cabeçalho 'Authorization'. Exemplo: Authorization: Bearer <SEU_TOKEN>

Path Parameters

​
instanceId
string<uuid>
required

O identificador único para a instância do portal cativo.

Example:

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

​
scheduleId
string<uuid>
required

O identificador único para o agendamento de cupons.

Example:

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

Body

application/json
​
name
string
required

Um nome legível para o agendamento.

Example:

"Passes Diários para Convidados"

​
count
integer
required

O número de cupons a serem gerados cada vez que o agendamento for executado.

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

20

​
recurrence_type
enum<string>
required

A frequência com que o agendamento deve ser executado.

Opções disponíveis:
daily,
weekly,
monthly
Example:

"daily"

​
valid_for_in_minutes
integer
required

O número de minutos que cada cupom gerado será válido.

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

480

​
timezone
string
required

O fuso horário no qual o agendamento deve ser avaliado (ex: 'America/Sao_Paulo').

Example:

"Australia/Sydney"

​
notification_group_id
string
required

O ID de um grupo de notificação para receber os cupons gerados.

Example:

"ng_a1b2c3d4e5f6"

​
day_of_week
integer | null

Obrigatório para recorrência 'weekly'. O dia da semana para executar (0=Domingo, 6=Sábado).

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

1

​
day_of_month
integer | null

Obrigatório para recorrência 'monthly'. O dia do mês para executar (1-31).

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

15

Response

O agendamento de cupons foi atualizado com sucesso.

​
id
string<uuid>

O identificador único para o agendamento de cupons.

Example:

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

​
name
string

Um nome legível para o agendamento.

Example:

"Passes Diários para Convidados"

​
instance_id
string<uuid>

O ID da instância à qual este agendamento pertence.

Example:

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

​
count
integer

O número de cupons a serem gerados cada vez que o agendamento for executado.

Example:

20

​
recurrence_type
enum<string>

A frequência com que o agendamento deve ser executado.

Opções disponíveis:
daily,
weekly,
monthly
Example:

"daily"

​
day_of_week
integer | null

Obrigatório para recorrência 'weekly'. O dia da semana para executar (0=Domingo, 6=Sábado).

Example:

1

​
day_of_month
integer | null

Obrigatório para recorrência 'monthly'. O dia do mês para executar (1-31).

Example:

15

​
valid_for_in_minutes
integer

O número de minutos que cada cupom gerado será válido após sua criação.

Example:

480

​
timezone
string

O fuso horário no qual o agendamento deve ser avaliado (ex: 'America/Sao_Paulo').

Example:

"Australia/Sydney"

​
notification_group_id
string

O ID de um grupo de notificação para receber os cupons gerados.

Example:

"ng_a1b2c3d4e5f6"

​
last_run_at
string<date-time> | null

O carimbo de data/hora da última vez que este agendamento foi executado com sucesso.

Example:

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

​
next_run_at
string<date-time> | null

O carimbo de data/hora calculado da próxima execução agendada.

Example:

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

​
tokens_used_since_last_run
integer

O número de cupons da última execução que foram resgatados.

Example:

5

​
tokens_generated_since_last_run
integer

O número total de cupons gerados na última execução.

Example:

20

​
tokens_available_since_last_run
integer

O número de cupons válidos e não resgatados restantes da última execução.

Example:

15

​
created_at
string<date-time>

O carimbo de data/hora de quando o agendamento foi criado.

Example:

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