> ## Documentation Index > Fetch the complete documentation index at: https://docs.athenahq.ai/llms.txt > Use this file to discover all available pages before exploring further. # Modifier un groupe > Modifie nom, ajoute/retire des sites et, pour les partenaires, définit/efface `external_id`. Au moins un champ et clé globale requis. Les **intégrations partenaires** fournissent `external_id` comme chaîne non vide pour définir/remplacer, `null` pour effacer. Leur réponse inclut `externalId` sur le groupe et chaque site de `websites` (`null` sans association). ## OpenAPI ````yaml fr/api-reference/openapi.json patch /api/v1/groups/{group_id} openapi: 3.1.0 info: title: API AthenaHQ description: >- L’API AthenaHQ permet de gérer vos sites et prompts par programme pour l’optimisation de contenu par IA. version: 1.0.0 contact: email: support@athenahq.ai servers: - url: https://api.athenahq.ai description: Serveur de production security: - apiKey: [] tags: - name: Basics description: Opérations API principales pour gérer sites et prompts - name: Metrics description: Points de terminaison de métriques et analyses de visibilité IA - name: Billing description: Points de facturation et crédits pour gérer la consommation - name: Team Management description: Points de terminaison de gestion des membres et invitations - name: Groups description: Points de terminaison de gestion des groupes de sites - name: Content description: >- Points de terminaison Content Hub : onglets, URL suivies et détail des prompts par URL. - name: Pitch Workspace description: >- Points de terminaison des rapports Pitch Workspace : exécutions à l’échelle de l’organisation avec concurrents, prompts, attributs et métriques agrégées. - name: Knowledge Base description: >- Endpoints de lecture de la base de connaissances de la marque — faits approuvés et piliers qui les organisent. paths: /api/v1/groups/{group_id}: parameters: - name: group_id in: path required: true schema: type: string format: uuid description: Identifiant unique du groupe example: 123e4567-e89b-12d3-a456-426614174000 patch: tags: - Groups summary: Modifier un groupe description: >- Modifie nom, ajoute/retire des sites et, pour les partenaires, définit/efface `external_id`. Au moins un champ et clé globale requis. Les **intégrations partenaires** fournissent `external_id` comme chaîne non vide pour définir/remplacer, `null` pour effacer. Leur réponse inclut `externalId` sur le groupe et chaque site de `websites` (`null` sans association). operationId: updateGroup requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateGroupRequest' responses: '200': description: >- Groupe mis à jour. Les réponses partenaires incluent `externalId` (chaîne ou `null`) ; celles des clients directs omettent le champ. content: application/json: schema: type: object properties: group: $ref: '#/components/schemas/Group' required: - group '400': description: >- Requête incorrecte - Erreur de validation ou ID de sites web invalides content: application/json: schema: $ref: '#/components/schemas/Error' examples: missing_fields: value: error: >- At least one of 'name', 'add_website_ids', 'remove_website_ids', 'external_id', or 'billing_enabled' is required invalid_website_ids: value: error: >- Website IDs not found in organization: 123e4567-e89b-12d3-a456-426614174000 invalid_group_id: value: error: Invalid group ID format '401': description: Non autorisé — clé API invalide ou absente content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Interdit - Nécessite une clé API globale ou (champ réservé aux partenaires) la clé n’a pas l’identité partenaire pour un `external_id`. content: application/json: schema: $ref: '#/components/schemas/Error' examples: global_required: summary: Clé API globale requise value: error: 'Forbidden: global API key required' partner_required: summary: Clé API partenaire requise pour external_id value: error: 'Forbidden: partner API key required' '404': description: Introuvable — groupe inexistant ou hors de votre organisation content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Group not found '409': description: >- Conflit — partenaires uniquement : `external_id` est déjà associé à un autre groupe. content: application/json: schema: $ref: '#/components/schemas/ExternalIdConflictError' examples: external_id_conflict: summary: external_id partenaire déjà associé value: error: external_id_conflict message: external_id acct_9e4c1b8d is already mapped to a group existing: id: 123e4567-e89b-12d3-a456-426614174000 externalId: acct_9e4c1b8d '500': description: Erreur interne du serveur content: application/json: schema: $ref: '#/components/schemas/Error' '502': description: >- Le fournisseur de facturation n’a pas pu provisionner l’entité. Renvoyé uniquement avec `billing_enabled: true` dans le corps. Aucun changement n’a été validé en base ; la requête peut être relancée sans effet résiduel. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Failed to provision billing entity security: - apiKey: [] components: schemas: UpdateGroupRequest: type: object description: Corps de modification d’un groupe. Au moins un champ requis. properties: name: type: string minLength: 1 description: Nouveau nom du groupe. example: Renamed Group add_website_ids: type: array minItems: 1 items: type: string format: uuid description: >- ID de sites à ajouter au groupe, de votre organisation. Les sites déjà membres sont ignorés silencieusement. example: - 123e4567-e89b-12d3-a456-426614174000 remove_website_ids: type: array minItems: 1 items: type: string format: uuid description: >- ID des sites à retirer du groupe. Ceux qui n’en font pas partie sont ignorés silencieusement. example: - 987e6543-e21b-12d3-a456-426614174000 external_id: type: string minLength: 1 nullable: true description: >- **Partenaires uniquement.** Identifiant partenaire à associer au groupe. Une chaîne non vide définit ou remplace l’association ; `null` l’efface. Accepté uniquement avec une clé API d’organisation partenaire. Un client direct reçoit `403 Forbidden`. Doit être unique par type de ressource dans l’organisation ; une valeur déjà utilisée par un autre groupe renvoie `409` avec la ressource existante. example: acct_9e4c1b8d billing_enabled: type: boolean description: >- Définissez sur `true` pour activer la facturation de ce groupe. Provisionne une entité de facturation chez le fournisseur en amont, préalable à l’attribution de crédits au groupe (opération réservée aux partenaires). Idempotent — peut être appelé sans risque sur des groupes dont l’entité n’a jamais été créée ou dont le provisionnement initial a échoué silencieusement. Définissez sur `false` pour désactiver l’indicateur sans détruire l’état de facturation existant ; les soldes de crédits et l’historique d’utilisation sont conservés. Renvoie `502` si le fournisseur de facturation ne parvient pas à provisionner l’entité — la base n’est alors pas modifiée et la requête peut être réessayée proprement. example: true Group: type: object description: Groupe de sites de votre organisation required: - id - name - orgId - billingEnabled - createdAt - websites properties: id: type: string format: uuid description: Identifiant unique du groupe example: 123e4567-e89b-12d3-a456-426614174000 name: type: string description: Nom d’affichage du groupe example: Enterprise Clients orgId: type: string format: uuid description: ID de l’organisation du groupe example: 987e6543-e21b-12d3-a456-426614174000 billingEnabled: type: boolean description: Indique si la facturation est activée pour ce groupe example: false createdAt: type: string format: date-time description: Horodatage de création du groupe (UTC) example: '2024-06-15T10:30:00.000Z' websites: type: array description: Sites web associés à ce groupe items: $ref: '#/components/schemas/GroupWebsite' externalId: type: string nullable: true description: >- **Partenaires uniquement.** Identifiant partenaire associé au groupe. Présent uniquement pour les appelants d’une organisation partenaire. Omis pour les clients directs. `null` indique l’absence d’association. example: acct_9e4c1b8d Error: type: object description: Objet de réponse d’erreur required: - error properties: error: type: string description: Message expliquant l’erreur example: Unauthorized ExternalIdConflictError: type: object description: >- Renvoyé si un partenaire définit un `external_id` déjà associé à une autre ressource du même type dans l’organisation. `existing` identifie la ressource détentrice pour récupérer une relance ou rapprocher les associations. required: - error - message - existing properties: error: type: string enum: - external_id_conflict description: Code d’erreur machine, toujours `external_id_conflict`. example: external_id_conflict message: type: string description: Explication lisible du conflit. example: external_id ws_a7f3b2c9 is already mapped to a website existing: type: object required: - id - externalId description: Ressource détenant actuellement le `external_id` en conflit. properties: id: type: string format: uuid description: ID Athena de la ressource existante. example: 123e4567-e89b-12d3-a456-426614174000 externalId: type: string description: external_id déjà associé. example: ws_a7f3b2c9 GroupWebsite: type: object description: Site associé à un groupe required: - id - websiteUrl - websiteName properties: id: type: string format: uuid description: Identifiant unique du site example: 123e4567-e89b-12d3-a456-426614174000 websiteUrl: type: string description: URL du site example: example.com websiteName: type: string description: Nom d’affichage du site example: My Awesome Blog externalId: type: string nullable: true description: >- **Partenaires uniquement.** Identifiant partenaire associé au site. Présent uniquement pour les organisations partenaires ; omis pour les clients directs. `null` sans association. example: ws_a7f3b2c9 securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: >- Clé API d’authentification. Créez-en une [ici](https://app.athenahq.ai/organization?tab=api). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.