Référence de l'APIPOST

Ajouter des mots-clés

Ajoute un ou plusieurs mots-clés à un site web surveillé pour que RedReplier score les fils correspondants.

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

Ajoute un ou plusieurs mots-clés à un site web surveillé pour que RedReplier score les fils correspondants.

Jeton Bearer (jeton API RedReplier)

Paramètres

  • websiteId (chemin, UUID, requis): Site web qui reçoit les mots-clés.

Corps de la requête

  • keywords (string[], requis, non vide): Valeurs de mots-clés à ajouter; chaque valeur peut contenir jusqu’à 255 caractères.

Réponse

Renvoie un objet Website public.

Objet Website

  • id (string): UUID du site web.
  • accountGroupId (string): Groupe de compte résolu depuis le token.
  • domain (string): Domaine normalisé du site web.
  • url (string): URL du site web.
  • name (string | null): Nom affiché.
  • description (string | null): Contexte utilisé pour le score de pertinence.
  • createdAt, updatedAt (ISO string | null): Horodatages de création et de mise à jour au format ISO 8601, ou null.
  • keywords (Keyword[]): Objets Keyword de ce site web.

Objet Keyword

  • 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

L’ajout de mots-clés est distinct de la modification. Les mots-clés qui tiennent dans le quota de l'abonnement passent à ACTIVE immédiatement. Les autres restent PENDING jusqu'à ce que l'abonnement ait de la place.

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