Skip to main content
POST
cURL
Este endpoint cria um novo lembrete de pagamento com notificações via WhatsApp e Email.

Descrição

O endpoint POST /tools/api/create-payment-reminder permite criar lembretes de pagamento únicos ou recorrentes. Você receberá notificações automáticas via WhatsApp e Email nos horários configurados.

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
Título do lembrete (ex: “Conta de luz”, “Aluguel”)
number
Valor do pagamento em BRL (opcional)
string
required
Data de vencimento no formato YYYY-MM-DD
string
Data/hora do lembrete em formato ISO 8601. Se não fornecido, será 1 dia antes do vencimento às 9h.
boolean
Se o lembrete é recorrente (padrão: false)
string
Padrão de recorrência: daily, weekly, monthly, ou yearly. Obrigatório se isRecurring=true.

Resposta

Sucesso (200)

Erro de Validação (400)

Erro de Autenticação (401)

Erro de Quota Excedida (403)

Campos da Resposta

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

Exemplos de Uso

cURL

JavaScript

Python

Códigos de Status

  • 200: Sucesso - Lembrete criado
  • 400: Parâmetros inválidos
  • 401: Erro de autenticação ou assinatura
  • 403: Quota excedida - limite de lembretes atingido
  • 500: Erro interno do servidor

Limites por Plano

  • BASIC: 5 lembretes ativos
  • PRO: 10 lembretes ativos
  • PREMIUM: 30 lembretes ativos

Recorrência

Os lembretes recorrentes são renovados automaticamente após a data de vencimento:
  • daily: Todos os dias no mesmo horário
  • weekly: Toda semana no mesmo dia da semana
  • monthly: Todo mês no mesmo dia do mês
  • yearly: Todo ano na mesma data
As notificações são enviadas via WhatsApp e Email no horário configurado. Se não especificado, o lembrete será enviado 1 dia antes do vencimento às 9h (horário de Brasília).
Para contas mensais fixas como aluguel, internet e outros serviços, use lembretes recorrentes para receber notificações automáticas todo mês.

Authorizations

Authorization
string
header
required

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

Body

application/json
title
string
required
dueDate
string<date>
required
amount
number
reminderTime
string<date-time>
isRecurring
boolean
default:false
recurrencePattern
enum<string>
Available options:
daily,
weekly,
monthly,
yearly

Response

Lembrete de pagamento criado com sucesso

success
boolean
Example:

true

data
object
message
string
Example:

"Payment reminder created successfully: Conta de luz"

timestamp
string<date-time>