API de lembretes
API para cancelar lembretes
Interrompa um lembrete recorrente para que ele nunca mais seja executado. Use-a quando um cliente pagar, uma assinatura terminar ou uma automação não for mais necessária.
https://wbiztool.com/api/v1/reminder/cancel/Corpo: JSON ou campos de formulário
Você precisa do reminder_id retornado por Criar lembrete. Se não o tiver, encontre-o com Listar lembretes.
Exemplo rápido#
curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
-H "Content-Type: application/json" \
-d '{
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"reminder_id": "3187"
}'import requests
reminder_id = 3187
response = requests.post(
"https://wbiztool.com/api/v1/reminder/cancel/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"reminder_id": reminder_id,
},
timeout=60,
)
try:
result = response.json() # read the body even when the HTTP code is 400 or 404
except ValueError:
raise SystemExit(f"HTTP {response.status_code}: not JSON. Check that your api_key exists.")
if result["status"] == 1:
print("Reminder cancelled")
else:
print("Failed:", result["message"])// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const reminderId = 3187;
const response = await fetch("https://wbiztool.com/api/v1/reminder/cancel/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
reminder_id: reminderId,
}),
});
// Read the body even when the HTTP code is 400 or 404. A non-JSON reply means the request crashed.
const text = await response.text();
let result;
try {
result = JSON.parse(text);
} catch {
throw new Error(`HTTP ${response.status}: not JSON. Check your api_key.`);
}
if (result.status === 1) {
console.log("Reminder cancelled");
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
'reminder_id' => 3187,
];
$ch = curl_init('https://wbiztool.com/api/v1/reminder/cancel/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
]);
$result = json_decode(curl_exec($ch), true);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($result === null) {
echo "HTTP $httpCode: not JSON. Check your api_key.";
} elseif ($result['status'] === 1) {
echo 'Reminder cancelled';
} else {
echo 'Failed: ' . $result['message'];
}Substitua 12345 e YOUR_API_KEY pelos seus próprios valores. Veja em Autenticação onde encontrá-los.
Parâmetros da requisição#
client_idintegerobrigatórioSeu ID do Cliente da API, em Configurações → Chaves API.
api_keystringobrigatórioSua chave de API, na mesma página.
reminder_idstringobrigatórioID do lembrete a cancelar, conforme retornado por Criar lembrete ou Listar lembretes. Ele precisa pertencer ao mesmo espaço de trabalho da chave de API.
Você também pode enviar campos de formulário em vez de JSON:
curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
-d client_id=12345 \
-d api_key=YOUR_API_KEY \
-d reminder_id=3187
Resposta#
Uma requisição bem-sucedida retorna HTTP 200:
{
"message": "Reminder cancelled successfully",
"status": 1
}
| Campo | Tipo | Descrição |
|---|---|---|
status | integer | 1 se o lembrete foi cancelado, 0 se a requisição falhou. |
message | string | Reminder cancelled successfully; caso contrário, o erro. |
Erros#
Os erros retornam HTTP 400 com status igual a 0, salvo indicação em contrário:
{ "status": 0, "message": "Reminder not found" }
| Mensagem | Como corrigir |
|---|---|
Invalid JSON format: … | O corpo JSON não é válido. Você também recebe esta mensagem em uma requisição de formulário sem client_id ou em qualquer requisição GET. |
Reminder ID cannot be null | Adicione reminder_id. |
Auth Error - Please send correct API key and Client id | Envie client_id e api_key. |
Invalid client id | Envie client_id como número. |
Invalid reminder id | reminder_id deve ser um número inteiro, como 3187. |
Auth Error: invalid api key | A chave não existe, foi excluída ou pertence a outro client_id. Teste-a com Verificar credenciais. |
Auth Error: please check client id | A chave não está vinculada a um espaço de trabalho. Crie uma nova chave no espaço de trabalho que você quer usar. |
Demo Account cannot access APIs | Use uma conta normal. |
Upgrade your plan to use reminders feature | Seu plano não inclui lembretes. Lembretes criados antes continuam sendo executados e enviando mensagens, e não podem ser cancelados nem pausados, pela API ou pelo painel, até você fazer upgrade. |
Reminder not found (HTTP 404) | O ID não existe, está em outro espaço de trabalho ou o lembrete já foi cancelado. |
Error cancelling reminder: … (HTTP 500) | Algo deu errado do nosso lado. Tente novamente. |
O que o cancelamento faz#
- O lembrete para imediatamente e não será executado novamente. Lembretes pausados também podem ser cancelados.
- Ele desaparece de Listar lembretes e da página Lembretes.
- Um lembrete cancelado não pode ser restaurado. Para recomeçar, crie um novo lembrete.
- Uma mensagem que o lembrete já colocou na fila antes do cancelamento não é removida e ainda pode ser enviada.
Dicas#
- Cancelar duas vezes retorna
Reminder not found. Se você repete requisições, trate essa mensagem como «já cancelado». - Pausar não está disponível pela API. Para interromper um lembrete temporariamente, pause-o na página Lembretes.
- Alterar um agendamento: não há API de atualização. Cancele o lembrete e crie um novo com a nova
cron_expression.
