Référence de l'APIDEL

Supprimer un mot-clé

Supprime définitivement un mot-clé, quel que soit son statut, avec toutes les mentions qu'il a produites.

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

Supprime définitivement un mot-clé, quel que soit son statut, avec toutes les mentions qu'il a produites.

Jeton Bearer (jeton API RedReplier)

Paramètres

  • keywordId (chemin, UUID, requis): Mot-clé à supprimer, quel que soit son statut.

Corps de la requête

Cet endpoint ne nécessite aucun corps JSON.

Réponse

Renvoie une confirmation de suppression.

  • deleted (boolean): Toujours true lorsque la suppression réussit.

Notes

Définitif: le mot-clé et toutes les mentions qu'il a produites sont supprimés, quel que soit son statut. Supprimer un mot-clé actif libère sa place dans l'abonnement, et le plus ancien mot-clé en attente qui y tient devient actif et sa surveillance démarre. Pour arrêter la surveillance en gardant les mentions, utilisez plutôt Désactiver un mot-clé.

Erreurs

  • 400 Bad Request: Entrée, URL, UUID, enum, paramètre de requête ou corps non valide.
  • 401 Unauthorized: Bearer token manquant ou non valide, ou code: "token_issuer_lost_access" quand la personne qui a créé la clé API a été désactivée ou a quitté l'espace de travail.
  • 403 Forbidden: code: "subscription_required" quand l'abonnement de l'espace de travail n'inclut pas l'accès à l'API, code: "workspace_access_denied" quand X-Workspace-Id désigne un espace de travail que ces identifiants ne peuvent pas atteindre, ou code: "permission_denied" quand votre rôle dans l'espace de travail n'a pas la permission redreplier.write (Admin et Editor l'ont).
  • 404 Not Found: La ressource n’existe pas pour le compte du token.
  • 429 Too Many Requests: Limite de débit dépassée. Attendez le nombre de secondes indiqué dans Retry-After.
  • 500 Internal Server Error: Erreur serveur inattendue.
Exemple de requête (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
}