Dokumentacja APIDEL

Usuwanie słowa kluczowego

Trwale usuń słowo kluczowe o dowolnym statusie wraz ze wszystkimi wzmiankami, które wygenerowało.

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

Trwale usuń słowo kluczowe o dowolnym statusie wraz ze wszystkimi wzmiankami, które wygenerowało.

Token Bearer (token API RedReplier)

Uwierzytelnianie

W każdym żądaniu wysyłaj token API RedReplier jako token Bearer. Tokeny zaczynają się od redreplier_, a RedReplier ustala konto na podstawie tokena. Aby działać w obszarze roboczym innym niż domyślny, wyślij X-Workspace-Id; zobacz Lista obszarów roboczych.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parametry

  • keywordId (ścieżka, UUID, wymagany): Słowo kluczowe do usunięcia, o dowolnym statusie.

Treść żądania

Ten endpoint nie wymaga treści JSON.

Odpowiedź

Zwraca potwierdzenie usunięcia.

  • deleted (boolean): Zawsze true, gdy usunięcie się powiedzie.

Przykładowe żądanie

curl -X DELETE https://ai.redreplier.com/ai-app/api/v1/keywords/22222222-2222-4222-8222-222222222222 \
  -H 'Authorization: Bearer redreplier_test_1234567890'

Uwagi

Operacja jest nieodwracalna: słowo kluczowe i wszystkie wygenerowane przez nie wzmianki zostają usunięte niezależnie od statusu. Usunięcie aktywnego słowa kluczowego zwalnia miejsce w planie, a najstarsze oczekujące słowo, które się w nim mieści, staje się aktywne i zaczyna być monitorowane. Aby zatrzymać monitorowanie i zachować wzmianki, użyj zamiast tego Wyłączanie słowa kluczowego.

Błędy

  • 400 Bad Request: Nieprawidłowe dane wejściowe, URL, UUID, wartość enum, parametr zapytania lub treść żądania.
  • 401 Unauthorized: Brak tokena Bearer lub token jest nieprawidłowy albo code: "token_issuer_lost_access", gdy osoba, która utworzyła klucz API, została dezaktywowana lub opuściła obszar roboczy.
  • 403 Forbidden: code: "subscription_required", gdy plan obszaru roboczego nie obejmuje dostępu do API, code: "workspace_access_denied", gdy X-Workspace-Id wskazuje obszar roboczy niedostępny dla tych danych uwierzytelniających, lub code: "permission_denied", gdy twoja rola w obszarze roboczym nie ma uprawnienia redreplier.write (mają je Administrator i Edytor).
  • 404 Not Found: Zasób nie istnieje dla konta przypisanego do tokena.
  • 429 Too Many Requests: Przekroczono limit żądań. Odczekaj liczbę sekund podaną w Retry-After.
  • 500 Internal Server Error: Nieoczekiwany błąd serwera.
Przykładowe żądanie (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
}