Pular para o conteúdo
Wbiztool

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.

POSThttps://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"
  }'

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ório

Seu ID do Cliente da API, em Configurações → Chaves API.

api_keystringobrigatório

Sua chave de API, na mesma página.

reminder_idstringobrigatório

ID 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.

Enviar campos de formulário evita o problema, porque todo valor de formulário é uma string:

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
}
CampoTipoDescrição
statusinteger1 se o lembrete foi cancelado, 0 se a requisição falhou.
messagestringReminder 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" }
MensagemComo 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 nullAdicione reminder_id.
Auth Error - Please send correct API key and Client idEnvie client_id e api_key.
Invalid client idEnvie client_id como número.
Invalid reminder idreminder_id deve ser um número inteiro, como 3187.
Auth Error: invalid api keyA chave pertence a outro client_id.
Auth Error: please check client idA 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 APIsUse uma conta normal.
Upgrade your plan to use reminders featureSeu plano não inclui lembretes. Lembretes criados antes continuam sendo executados e consumindo créditos, 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.

Se a api_key não existir ou tiver sido excluída, a resposta é uma página de erro HTML com HTTP 500 em vez de JSON. Teste sua chave com Verificar credenciais.

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.