Dokumentacja APIPATCH

Edytuj słowo kluczowe

Zmień tekst istniejącego słowa kluczowego, do 255 znaków, bez utraty jego obecnego statusu.

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

Zmień tekst istniejącego słowa kluczowego, do 255 znaków, bez utraty jego obecnego statusu.

Token Bearer (token API RedReplier)

Uwierzytelnianie

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

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parametry

  • keywordId (ścieżka, UUID, wymagany): Słowo kluczowe do edycji.

Treść żądania

  • value (string, wymagany, maks. 255): Nowy tekst słowa kluczowego.

Odpowiedź

Zwraca jeden publiczny obiekt Keyword.

  • id (string): UUID słowa kluczowego.
  • websiteId (string): UUID strony nadrzędnej.
  • value (string): Tekst słowa kluczowego, do 255 znaków.
  • status (string): PENDING, ACTIVE, DISABLED lub SUSPENDED.
  • createdAt, updatedAt (ISO string | null): Znaczniki czasu utworzenia i aktualizacji w formacie ISO 8601 lub null.

Przykładowe żądanie

curl -X PATCH https://ai.redreplier.com/ai-app/api/v1/keywords/22222222-2222-4222-8222-222222222222 \
  -H 'Authorization: Bearer redreplier_test_1234567890' \
  -H 'Content-Type: application/json' \
  -d '{"value":"agency CRM recommendations"}'

Uwagi

Liczba edycji jest nieograniczona, a słowo kluczowe zachowuje opłacone miejsce, które już zajmuje: słowo ACTIVE pozostaje ACTIVE, a każde inne staje się ACTIVE, gdy plan ma wolne miejsce, w przeciwnym razie PENDING. Zmiana dotycząca wyłącznie wielkości liter niczego nie zmienia, a wartość powielająca inne słowo kluczowe tej samej strony zwraca 400. Edycja słowa o statusie SUSPENDED to standardowy sposób na poprawienie fraz generujących szum.

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 nieprawidłowy token 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 poświadczeń, 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 powiązanego z tokenem.
  • 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 PATCH \
  --url https://ai.redreplier.com/ai-app/api/v1/keywords/73a3c9b6-3e5f-4a53-a2c6-70c5ef7f2f6d \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"value": "CRM for agencies"}'
200
{
  "id": "73a3c9b6-3e5f-4a53-a2c6-70c5ef7f2f6d",
  "websiteId": "9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10",
  "value": "agency CRM",
  "status": "ACTIVE",
  "createdAt": "2026-05-22T10:16:00.000Z",
  "updatedAt": "2026-05-29T14:02:11.000Z"
}