API-ReferenzPOST

Keywords hinzufügen

Fügt einer überwachten Website ein oder mehrere Keywords hinzu, damit RedReplier passende Threads dafür bewertet.

POSThttps://ai.redreplier.com/ai-app/api/v1/websites/{websiteId}/keywords

Fügt einer überwachten Website ein oder mehrere Keywords hinzu, damit RedReplier passende Threads dafür bewertet.

Bearer-Token (RedReplier-API-Token)

Parameter

  • websiteId (Pfad, UUID, erforderlich): Website, die Keywords erhält.

Request-Body

  • keywords (String[], erforderlich, nicht leer): Hinzuzufügende Keyword-Werte; jeder Wert darf bis zu 255 Zeichen haben.

Antwort

Gibt ein öffentliches Website-Objekt zurück.

Website-Objekt

  • id (string): Website-UUID.
  • accountGroupId (string): Aus dem Token ermittelte Account-Gruppe.
  • domain (string): Normalisierte Website-Domain.
  • url (string): Website-URL.
  • name (string | null): Anzeigename.
  • description (string | null): Kontext für die Relevanzbewertung.
  • createdAt, updatedAt (ISO string | null): Erstellungs- und Aktualisierungszeitpunkte im ISO-8601-Format oder null.
  • keywords (Keyword[]): Keyword-Objekte für diese Website.

Keyword-Objekt

  • 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

Keywords hinzufügen ist getrennt vom Bearbeiten. Keywords, die in das Kontingent des Tarifs passen, werden sofort ACTIVE. Der Rest bleibt PENDING, bis der Tarif Platz hat.

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 POST \
  --url https://ai.redreplier.com/ai-app/api/v1/websites/9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10/keywords \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"keywords":["agency CRM","client follow-up software","sales pipeline for agencies"]}'
201
{
  "id": "9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10",
  "accountGroupId": "acct_7dK9pQ2",
  "domain": "acmecrm.io",
  "url": "https://acmecrm.io",
  "name": "Acme CRM",
  "description": "CRM for small agencies that need pipeline tracking and client follow-up reminders.",
  "createdAt": "2026-05-22T10:15:30.000Z",
  "updatedAt": "2026-05-29T14:02:11.000Z",
  "keywords": [
    {
      "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"
    }
  ]
}