API-ReferenzPATCH

Keyword bearbeiten

Ändert den Text eines vorhandenen Keywords mit bis zu 255 Zeichen, ohne seinen aktuellen Status zu verlieren.

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

Ändert den Text eines vorhandenen Keywords mit bis zu 255 Zeichen, ohne seinen aktuellen Status zu verlieren.

Bearer-Token (RedReplier-API-Token)

Parameter

  • keywordId (Pfad, UUID, erforderlich): Keyword, das bearbeitet wird.

Request-Body

  • value (String, erforderlich, max. 255): Neuer Keyword-Text.

Antwort

Gibt ein öffentliches Keyword-Objekt zurück.

  • id (string): Keyword-UUID.
  • websiteId (string): UUID der übergeordneten Website.
  • value (string): Keyword-Text mit bis zu 255 Zeichen.
  • status (string): PENDING, ACTIVE, DISABLED oder SUSPENDED.
  • createdAt, updatedAt (ISO string | null): Erstellungs- und Aktualisierungszeitpunkte im ISO-8601-Format oder null.

Hinweise

Bearbeitungen sind unbegrenzt und behalten den bezahlten Platz, den das Keyword schon hat: Ein ACTIVE Keyword bleibt ACTIVE, jedes andere wird ACTIVE, wenn der Tarif einen freien Platz hat, sonst PENDING. Eine reine Änderung der Groß- und Kleinschreibung bewirkt nichts, und ein Wert, der ein anderes Keyword derselben Website dupliziert, liefert 400. Ein SUSPENDED Keyword zu bearbeiten ist der normale Weg, ungenaue Begriffe zu korrigieren.

Fehler

  • 400 Bad Request: Ungültige Eingabe, URL, UUID, Enum, Query-Parameter oder Body.
  • 401 Unauthorized: Fehlendes oder ungültiges Bearer-Token, oder code: "token_issuer_lost_access", wenn die Person, die den API-Schlüssel erstellt hat, deaktiviert wurde oder den Workspace verlassen hat.
  • 403 Forbidden: code: "subscription_required", wenn der Tarif des Workspace keinen API-Zugang enthält, code: "workspace_access_denied", wenn X-Workspace-Id einen Workspace nennt, den diese Zugangsdaten nicht erreichen, oder code: "permission_denied", wenn Ihre Rolle im Workspace die Berechtigung redreplier.write nicht hat (Admin und Editor haben sie).
  • 404 Not Found: Die Ressource existiert nicht für das Token-Konto.
  • 429 Too Many Requests: Rate-Limit überschritten. Warten Sie die Sekunden aus Retry-After ab.
  • 500 Internal Server Error: Unerwarteter Serverfehler.
Beispielanfrage (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"
}