API-referentiePATCH

Website bijwerken

Werk de weergavenaam of beschrijving van een gemonitorde website bij, die RedReplier gebruikt voor relevantiescores.

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

Werk de weergavenaam of beschrijving van een gemonitorde website bij, die RedReplier gebruikt voor relevantiescores.

Bearer-token (RedReplier API-token)

Authenticatie

Stuur bij elk verzoek een RedReplier API-token mee als Bearer-token. Tokens beginnen met redreplier_; RedReplier haalt het account uit het token. Stuur X-Workspace-Id mee om in een andere workspace dan de standaard te werken; zie Workspaces weergeven.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parameters

  • websiteId (pad, UUID, verplicht): De website die je wilt bijwerken.

Request body

  • name (string, optioneel): Nieuwe weergavenaam.
  • description (string, optioneel, max. 5000): Nieuwe beschrijving voor de relevantiescores.

Respons

Geeft één openbaar Website-object terug.

Website-object

  • id (string): UUID van de website.
  • accountGroupId (string): Accountgroep die uit het token is afgeleid.
  • domain (string): Genormaliseerd domein van de website.
  • url (string): URL van de website.
  • name (string | null): Weergavenaam.
  • description (string | null): Context die voor relevantiescores wordt gebruikt.
  • createdAt, updatedAt (ISO string | null): Tijdstempels van aanmaken en bijwerken in ISO 8601-formaat, of null.
  • keywords (Keyword[]): Keyword-objecten van deze website.

Keyword-object

  • id (string): UUID van het trefwoord.
  • websiteId (string): UUID van de bovenliggende website.
  • value (string): Tekst van het trefwoord, maximaal 255 tekens.
  • status (string): PENDING, ACTIVE, DISABLED of SUSPENDED.
  • createdAt, updatedAt (ISO string | null): Tijdstempels van aanmaken en bijwerken in ISO 8601-formaat, of null.

Voorbeeldverzoek

curl -X PATCH https://ai.redreplier.com/ai-app/api/v1/websites/11111111-1111-4111-8111-111111111111 \
  -H 'Authorization: Bearer redreplier_test_1234567890' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Acme CRM","description":"CRM and client portal for B2B agencies."}'

Opmerkingen

Houd de beschrijving accuraat; ze beïnvloedt de AI-relevantiescores.

Fouten

  • 400 Bad Request: Ongeldige invoer, URL, UUID, enum, queryparameter of body.
  • 401 Unauthorized: Bearer-token ontbreekt of is ongeldig, of code: "token_issuer_lost_access" als de persoon die de API-sleutel heeft aangemaakt is gedeactiveerd of de workspace heeft verlaten.
  • 403 Forbidden: code: "subscription_required" als het abonnement van de workspace geen API-toegang bevat, code: "workspace_access_denied" als X-Workspace-Id een workspace noemt waar deze inloggegevens geen toegang toe hebben, of code: "permission_denied" als je rol in de workspace geen redreplier.write heeft (Admin en Editor hebben die wel).
  • 404 Not Found: De resource bestaat niet voor het account van het token.
  • 429 Too Many Requests: Rate limit overschreden. Wacht het aantal seconden uit Retry-After.
  • 500 Internal Server Error: Onverwachte serverfout.
Voorbeeldverzoek (curl)
curl --request PATCH \
  --url https://ai.redreplier.com/ai-app/api/v1/websites/9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10 \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"name": "Acme CRM","description": "CRM for small agencies that need pipeline tracking and follow-up reminders."}'
200
{
  "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"
    }
  ]
}