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.
Bearer token com a API key do usuário. Formato: Bearer sk-your-api-key-here
Parâmetros de Query Parâmetro interno para indicar requisições via MCP. Use s=s para requisições MCP.
Body Parameters ID do lembrete a ser atualizado
Novo título do lembrete (opcional)
Novo valor do pagamento em BRL (opcional)
Nova data de vencimento no formato YYYY-MM-DD (opcional)
Nova data/hora do lembrete em formato ISO 8601 (opcional)
Novo horário de recorrência (ex: ‘8h’, ‘14h30’) (opcional)
Novo status: active, completed, ou inactive (opcional)
Resposta Sucesso (200) { "success" : true , "data" : { "id" : "pr_123456789" , "title" : "Conta de luz - Residência" , "amount" : 180.00 , "dueDate" : "2024-12-20" , "reminderTime" : "2024-12-19T09:00:00Z" , "recurrenceTime" : "9h" , "status" : "active" , "isRecurring" : false , "recurrencePattern" : null , "createdAt" : "2024-11-20T10:00:00Z" , "updatedAt" : "2024-11-27T16:00:00Z" }, "message" : "Payment reminder updated successfully" , "timestamp" : "2024-11-27T16:00:00Z" }
Erro de Validação (400) Error - Missing ID
Error - Invalid Date
{ "error" : "Invalid or missing reminderId" , "message" : "reminderId must be provided" }
Erro de Autenticação (401) { "error" : "Invalid or inactive API key" , "message" : "Please check your API key and try again" , "type" : "invalid_api_key" }
Erro de Acesso (403) { "error" : "Unauthorized" , "message" : "You do not have permission to update this reminder" }
Lembrete Não Encontrado (404) { "error" : "Reminder not found" , "message" : "No reminder found with ID: pr_123456789" }
Campos da Resposta Indica se a requisição foi bem-sucedida
Objeto com os dados atualizados do lembrete Show Payment Reminder Object
Identificador único do lembrete
Título atualizado do lembrete
Valor atualizado do pagamento em BRL
Data de vencimento atualizada (YYYY-MM-DD)
Data/hora atualizada do lembrete (ISO 8601)
Horário de recorrência atualizado
Status atualizado: active, completed, ou inactive
Se o lembrete é recorrente
Data de criação original (ISO 8601)
Data da última atualização (ISO 8601)
Mensagem de confirmação da atualização
Timestamp da requisição em formato ISO 8601
Exemplos de Uso cURL # Atualizar título e valor curl -X PUT 'https://www.pierre.finance/tools/api/update-payment-reminder' \ -H 'Authorization: Bearer sk-your-api-key-here' \ -H 'Content-Type: application/json' \ -d '{ "reminderId": "pr_123456789", "title": "Conta de luz - Residência", "amount": 180.00 }' # Atualizar data de vencimento curl -X PUT 'https://www.pierre.finance/tools/api/update-payment-reminder' \ -H 'Authorization: Bearer sk-your-api-key-here' \ -H 'Content-Type: application/json' \ -d '{ "reminderId": "pr_123456789", "dueDate": "2024-12-20" }' # Marcar como completado curl -X PUT 'https://www.pierre.finance/tools/api/update-payment-reminder' \ -H 'Authorization: Bearer sk-your-api-key-here' \ -H 'Content-Type: application/json' \ -d '{ "reminderId": "pr_123456789", "newStatus": "completed" }'
JavaScript const API_KEY = 'sk-your-api-key-here' ; const BASE_URL = 'https://www.pierre.finance/tools/api' ; async function updatePaymentReminder ( reminderId , updates ) { const response = await fetch ( ` ${ BASE_URL } /update-payment-reminder` , { method: 'PUT' , headers: { 'Authorization' : `Bearer ${ API_KEY } ` , 'Content-Type' : 'application/json' }, body: JSON . stringify ({ reminderId , ... updates }) }); return await response . json (); } // Exemplos de uso updatePaymentReminder ( 'pr_123456789' , { title: 'Conta de luz - Residência' , amount: 180 }); updatePaymentReminder ( 'pr_123456789' , { dueDate: '2024-12-20' }); updatePaymentReminder ( 'pr_123456789' , { newStatus: 'completed' });
Python import requests API_KEY = 'sk-your-api-key-here' BASE_URL = 'https://www.pierre.finance/tools/api' headers = { 'Authorization' : f 'Bearer { API_KEY } ' , 'Content-Type' : 'application/json' } def update_payment_reminder ( reminder_id , ** updates ): data = { 'reminderId' : reminder_id, ** updates} response = requests.put( f ' { BASE_URL } /update-payment-reminder' , headers = headers, json = data) return response.json() # Exemplos de uso update_payment_reminder( 'pr_123456789' , title = 'Conta de luz - Residência' , amount = 180 ) update_payment_reminder( 'pr_123456789' , dueDate = '2024-12-20' ) update_payment_reminder( 'pr_123456789' , newStatus = 'completed' )
Códigos de Status
200: Sucesso - Lembrete atualizado400: Parâmetros inválidos401: Erro de autenticação ou assinatura403: Acesso negado - lembrete pertence a outro usuário404: Lembrete não encontrado500: Erro interno do servidor
Status Disponíveis
active : Lembrete ativo e enviando notificaçõescompleted : Pagamento realizado, lembrete completadoinactive : 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.
API key in Bearer token format. Example: Bearer sk-your-api-key-here
Available options:
active,
completed,
inactive
Lembrete de pagamento atualizado com sucesso
Example: "Payment reminder updated successfully"
