API-referentiePATCH

Trefwoord bewerken

Wijzig de tekst van een bestaand trefwoord, tot 255 tekens, zonder de huidige status te verliezen.

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

Wijzig de tekst van een bestaand trefwoord, tot 255 tekens, zonder de huidige status te verliezen.

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

  • keywordId (pad, UUID, verplicht): Het trefwoord dat je wilt bewerken.

Request body

  • value (string, verplicht, max. 255): Nieuwe tekst van het trefwoord.

Respons

Geeft één openbaar Keyword-object terug.

  • 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/keywords/22222222-2222-4222-8222-222222222222 \
  -H 'Authorization: Bearer redreplier_test_1234567890' \
  -H 'Content-Type: application/json' \
  -d '{"value":"agency CRM recommendations"}'

Opmerkingen

Je kunt onbeperkt bewerken en het trefwoord houdt elke betaalde plek die het al heeft: een ACTIVE trefwoord blijft ACTIVE, en elk ander trefwoord wordt ACTIVE als het abonnement een vrije plek heeft, anders PENDING. Een wijziging die alleen hoofdletters en kleine letters aanpast, doet niets, en een waarde die gelijk is aan een ander trefwoord op dezelfde website geeft een 400. Een SUSPENDED trefwoord bewerken is de normale manier om termen met veel ruis te verbeteren.

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/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"
}