Referência da APIDEL

Excluir palavra-chave

Exclui permanentemente uma palavra-chave em qualquer status, junto com todas as menções que ela gerou.

DELETEhttps://ai.redreplier.com/ai-app/api/v1/keywords/{keywordId}

Exclui permanentemente uma palavra-chave em qualquer status, junto com todas as menções que ela gerou.

Token Bearer (token de API do RedReplier)

Parâmetros

  • keywordId (caminho, UUID, obrigatório): Palavra-chave a ser excluída, em qualquer status.

Corpo da requisição

Este endpoint não exige um corpo JSON.

Resposta

Retorna uma confirmação de exclusão.

  • deleted (boolean): Sempre true quando a exclusão é concluída com sucesso.

Notas

Permanente: a palavra-chave e todas as menções que ela gerou são excluídas, qualquer que seja o status. Excluir uma palavra-chave ativa libera a vaga dela no plano, e a palavra-chave pendente mais antiga que caiba fica ativa e começa a ser monitorada. Para parar o monitoramento e manter as menções, use Desativar palavra-chave.

Erros

  • 400 Bad Request: Entrada, URL, UUID, enum, parâmetro de consulta ou corpo inválido.
  • 401 Unauthorized: Bearer token ausente ou inválido, ou code: "token_issuer_lost_access" quando a pessoa que criou a chave API foi desativada ou saiu do workspace.
  • 403 Forbidden: code: "subscription_required" quando o plano do workspace não inclui acesso à API, code: "workspace_access_denied" quando X-Workspace-Id indica um workspace que esta credencial não pode alcançar, ou code: "permission_denied" quando seu papel no workspace não tem a permissão redreplier.write (Admin e Editor têm).
  • 404 Not Found: O recurso não existe para a conta do token.
  • 429 Too Many Requests: Limite de requisições excedido. Aguarde os segundos indicados em Retry-After.
  • 500 Internal Server Error: Erro inesperado do servidor.
Exemplo de solicitação (curl)
curl --request DELETE \
  --url https://ai.redreplier.com/ai-app/api/v1/keywords/73a3c9b6-3e5f-4a53-a2c6-70c5ef7f2f6d \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "deleted": true
}