VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Assinantes da newsletter

Remover assinante

Apaga permanentemente um assinante pelo UUID.

Apaga o registro de um assinante. A exclusão é permanente: não fica histórico nem marca de cancelamento, e o e-mail pode ser inscrito de novo como se fosse novo. Use para atender a um pedido de exclusão de dados.

DELETE/api/v1.0/subscribers/{id}Admin

Remover um assinante

Parâmetros de caminho

iduuidobrigatório
Id do assinante (UUID), como devolvido em subscriber_id por /api/v1.0/subscribers. O id decimal da forma /api/... não é aceito.
DELETE/api/subscribers/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de DELETE /api/v1.0/subscribers/{id}. Use este caminho se o seu cliente já foi escrito para ele. Nesta forma sem versão o subscriber_id sai como número decimal em string, mas o caminho /{id} só aceita o UUID.

Exemplo de requisição

bash
curl -X DELETE "$BASE_URL/api/v1.0/subscribers/43053e7f-c17b-4c8a-8009-649f1c0cef85" \
  -u "$EMAIL:$API_KEY"

Resposta

204Assinante removido

Resposta vazia: o corpo não tem conteúdo.

Erros

StatusQuandoCorpo de exemplo
401Sem credencial.{"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."}
401E-mail ou chave de API inválidos.{"status":401,"message":"Invalid credentials"}
403A credencial é válida, mas o usuário não é administrador.{"status":403,"message":"Forbidden: admin scope required"}
500Não existe assinante com esse UUID (inclusive numa segunda exclusão) ou o id não tem formato de UUID. Deveria ser 404; é uma falha conhecida.{"status":500,"message":"Failed to delete subscriber: subscriber not found"}
Irreversível

Não há como restaurar. Se a pessoa só quer parar de receber, o caminho certo é o link de cancelamento do e-mail, que muda a situação para U e preserva o registro de consentimento.

Veja também

  • Listar assinantes
  • Inscrever assinante
  • Visão geral de assinantes
Anterior
Inscrever assinante
Próxima
Lojas, vendors e companies
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também