Skip to main content
PATCH

Parâmetros de rota

string
required
ID da programação.

Corpo da requisição

Envie ao menos um campo. Não é possível alterar payload nem triggerType após a criação.
string
ACTIVE (retomar) ou PAUSED (pausar).
string
Nova data/hora ISO 8601 (agendamento único ONCE).
object
Nova regra de recorrência (interval, time, timezone, dayOfWeek, dayOfMonth, customDays).
number
Novo saldo mínimo em reais (regra BALANCE_THRESHOLD).
integer
Novo limite de execuções (1–9999).
string
Novo rótulo (máx. 120 caracteres).

Campos principais em data

Mesma estrutura de Consultar programação. O status na resposta reflete active ou paused conforme ACTIVE/PAUSED enviado.

Authorizations

X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Path Parameters

id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

Body

application/json
label
string
Maximum string length: 120
status
enum<string>
Available options:
ACTIVE,
PAUSED
scheduledAt
string<date-time>
recurrenceRule
object
balanceThreshold
number
Required range: x >= 0
maxRuns
integer
Required range: 1 <= x <= 9999

Response

Programação de transferência criada, consultada ou atualizada.

success
boolean
required
message
string
required
data
object
required
requestId
string