cURL
Payment Reminders
Create Payment Reminder
Cria um novo lembrete de pagamento. Permite criar lembretes únicos ou recorrentes com notificações via WhatsApp e Email. Requer API key para autenticação e assinatura ativa. O usuário deve ter cota disponível baseada no seu plano.
POST
cURL
Este endpoint cria um novo lembrete de pagamento com notificações via WhatsApp e Email.
Descrição
O endpointPOST /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-hereParâ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 criado400: Parâmetros inválidos401: Erro de autenticação ou assinatura403: Quota excedida - limite de lembretes atingido500: 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).
Authorizations
API key in Bearer token format. Example: Bearer sk-your-api-key-here
Body
application/json

