Skip to main content
PUT
cURL
Este endpoint atualiza um lembrete de pagamento existente.

Descrição

O endpoint PUT /tools/api/update-payment-reminder permite modificar título, valor, datas, padrão de recorrência e status de lembretes de pagamento. O usuário só pode atualizar seus próprios lembretes.

Autenticação

Este endpoint requer autenticação via Bearer token.
string
required
Bearer token com a API key do usuário. Formato: Bearer sk-your-api-key-here

Parâmetros de Query

string
required
Parâmetro interno para indicar requisições via MCP. Use s=s para requisições MCP.

Body Parameters

string
required
ID do lembrete a ser atualizado
string
Novo título do lembrete (opcional)
number
Novo valor do pagamento em BRL (opcional)
string
Nova data de vencimento no formato YYYY-MM-DD (opcional)
string
Nova data/hora do lembrete em formato ISO 8601 (opcional)
string
Novo horário de recorrência (ex: ‘8h’, ‘14h30’) (opcional)
string
Novo status: active, completed, ou inactive (opcional)

Resposta

Sucesso (200)

Erro de Validação (400)

Erro de Autenticação (401)

Erro de Acesso (403)

Lembrete Não Encontrado (404)

Campos da Resposta

boolean
required
Indica se a requisição foi bem-sucedida
object
required
Objeto com os dados atualizados do lembrete
string
required
Mensagem de confirmação da atualização
string
required
Timestamp da requisição em formato ISO 8601

Exemplos de Uso

cURL

JavaScript

Python

Códigos de Status

  • 200: Sucesso - Lembrete atualizado
  • 400: Parâmetros inválidos
  • 401: Erro de autenticação ou assinatura
  • 403: Acesso negado - lembrete pertence a outro usuário
  • 404: Lembrete não encontrado
  • 500: Erro interno do servidor

Status Disponíveis

  • active: Lembrete ativo e enviando notificações
  • completed: Pagamento realizado, lembrete completado
  • inactive: Lembrete desativado, não envia notificações
Ao marcar um lembrete como completed, ele não conta mais para o limite de quota do plano. Lembretes recorrentes são renovados automaticamente mesmo após completados.
Use newStatus: 'inactive' para pausar temporariamente um lembrete sem excluí-lo. Você pode reativá-lo depois alterando o status para active.

Authorizations

Authorization
string
header
required

API key in Bearer token format. Example: Bearer sk-your-api-key-here

Body

application/json
reminderId
string
required
title
string
amount
number
dueDate
string<date>
reminderTime
string<date-time>
newStatus
enum<string>
Available options:
active,
completed,
inactive

Response

Lembrete de pagamento atualizado com sucesso

success
boolean
Example:

true

data
object
message
string
Example:

"Payment reminder updated successfully"

timestamp
string<date-time>