Website erstellen

Parameter

Dieser Endpoint hat keine Pfad- oder Query-Parameter.

Request-Body

• url (String, URL, erforderlich): Website-URL.
• name (String, optional): Anzeigename.
• keywords (String[], optional): Anfängliche Keyword-Werte; jeder Wert darf bis zu 255 Zeichen haben.
• description (String, optional, max. 5000): Manuelle Website-Beschreibung. Fehlt sie, crawlt RedReplier die URL und schreibt eine, was eine KI-Generierung aus dem Plankontingent verbraucht. Schlägt das Crawlen fehl oder ist das Kontingent aufgebraucht, wird die Website trotzdem mit description: null angelegt; setzen Sie dann eine mit PATCH /websites/{id} oder POST /websites/analyze-description. Senden Sie description: "", um Crawlen und KI-Analyse zu überspringen: Es wird keine Generierung verbraucht und die Website startet ohne Beschreibung.

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

Anfängliche Keywords werden als PENDING gespeichert. Die, die in den Tarif passen, werden beim nächsten Aufruf von GET /websites oder POST /websites/{websiteId}/keywords ACTIVE; der Rest bleibt PENDING, bis der Tarif in der RedReplier-App erhöht wird. Eine Domain, die in diesem Workspace schon überwacht wird, liefert 400, ebenso ein Tarif ohne freien Website-Platz. Eine gelöschte Domain erneut hinzuzufügen stellt diese Website wieder her.

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.