Référence de l'APIPATCH

Modifier un mot-clé

Modifie le texte d’un mot-clé existant, jusqu’à 255 caractères, sans perdre son statut actuel.

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

Modifie le texte d’un mot-clé existant, jusqu’à 255 caractères, sans perdre son statut actuel.

Jeton Bearer (jeton API RedReplier)

Paramètres

  • keywordId (chemin, UUID, requis): Mot-clé à modifier.

Corps de la requête

  • value (string, requis, max 255): Nouveau texte du mot-clé.

Réponse

Renvoie un objet Keyword public.

  • id (string): UUID du mot-clé.
  • websiteId (string): UUID du site web parent.
  • value (string): Texte du mot-clé, jusqu’à 255 caractères.
  • status (string): PENDING, ACTIVE, DISABLED ou SUSPENDED.
  • createdAt, updatedAt (ISO string | null): Horodatages de création et de mise à jour au format ISO 8601, ou null.

Notes

Les modifications sont illimitées et conservent la place payée que le mot-clé occupe déjà: un mot-clé ACTIVE reste ACTIVE, et tout autre mot-clé devient ACTIVE si l'abonnement a une place libre, sinon PENDING. Un changement de casse seul ne fait rien, et une valeur qui duplique un autre mot-clé du même site web renvoie 400. Modifier un mot-clé SUSPENDED est la méthode normale pour corriger des termes trop bruyants.

Erreurs

  • 400 Bad Request: Entrée, URL, UUID, enum, paramètre de requête ou corps non valide.
  • 401 Unauthorized: Bearer token manquant ou non valide, ou code: "token_issuer_lost_access" quand la personne qui a créé la clé API a été désactivée ou a quitté l'espace de travail.
  • 403 Forbidden: code: "subscription_required" quand l'abonnement de l'espace de travail n'inclut pas l'accès à l'API, code: "workspace_access_denied" quand X-Workspace-Id désigne un espace de travail que ces identifiants ne peuvent pas atteindre, ou code: "permission_denied" quand votre rôle dans l'espace de travail n'a pas la permission redreplier.write (Admin et Editor l'ont).
  • 404 Not Found: La ressource n’existe pas pour le compte du token.
  • 429 Too Many Requests: Limite de débit dépassée. Attendez le nombre de secondes indiqué dans Retry-After.
  • 500 Internal Server Error: Erreur serveur inattendue.
Exemple de requête (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"
}