> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firma.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Mettre à jour un espace de travail

> Met à jour les informations d'un espace de travail existant. Il s'agit d'une opération de remplacement complet nécessitant le champ name.



## OpenAPI

````yaml api-reference/v01.30.00/openapi-v01.30.00.fr.json put /workspaces/{id}
openapi: 3.0.3
info:
  title: API Partenaire Firma
  description: >-
    API RESTful pour la signature de documents et la gestion de modèles.


    **Authentification** : Tous les endpoints nécessitent une authentification
    par clé API via l'en-tête `Authorization`. Utilisez votre clé API
    directement sans préfixe (par exemple, `your-api-key`). Le préfixe Bearer
    est optionnel mais pas obligatoire.


    **Fonctionnalités de sécurité** :

    - Validation des entrées avec des schémas Zod incluant des messages d'erreur
    détaillés au niveau des champs

    - Jetons JWT signés RSA-256 pour l'accès aux modèles intégrés


    **Limitation de débit** : Les limites de débit sont hiérarchisées selon le
    type d'opération :

    - Opérations de lecture (GET) : 200 requêtes par minute

    - Opérations d'écriture (POST/PUT/PATCH/DELETE) : 120 requêtes par minute

    - Opérations CRUD sur les webhooks : 60 requêtes par minute

    - Test de webhook : 10 requêtes par minute

    - Régénération/expiration de clé API : 1 requête par minute

    - Rotation du secret de webhook : 1 requête par minute


    Lorsque les limites de débit sont dépassées, l'API renvoie une réponse `429
    Too Many Requests` avec les en-têtes suivants :

    - `X-RateLimit-Limit` : Nombre maximal de requêtes par minute pour cet
    endpoint

    - `X-RateLimit-Remaining` : Requêtes restantes dans la fenêtre actuelle

    - `X-RateLimit-Reset` : Horodatage Unix de la réinitialisation de la limite

    - `Retry-After` : Secondes à attendre avant de pouvoir réessayer


    **Gestion des erreurs** : Toutes les erreurs renvoient des réponses JSON
    structurées avec `error` (message lisible par un humain), `code`
    (identifiant lisible par une machine) et `details` (erreurs de validation au
    niveau des champs, le cas échéant).


    **Intégration de l'Éditeur de Modèles intégré** : L'Éditeur de Modèles Firma
    peut être intégré dans votre application à l'aide d'une bibliothèque
    JavaScript autonome.


    ```html

    <!-- Charger la bibliothèque de l'Éditeur de Modèles Firma -->

    <script
    src="https://api.firma.dev/functions/v1/embed-proxy/template-editor.js"></script>


    <script>

    // Générer d'abord un jeton JWT via l'API

    fetch('https://api.firma.dev/functions/v1/signing-request-api/generate-template-token',
    {
      method: 'POST',
      headers: {
        'Authorization': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        companies_workspaces_templates_id: 'template-id'
      })
    })

    .then(res => res.json())

    .then(data => {
      // Initialiser l'éditeur avec le jeton JWT
      window.FirmaTemplateEditor.init({
        container: '#firma-editor-container',
        jwt: data.token,
        templateId: 'template-id',
        theme: 'dark',
        readOnly: false,
        onSave: (savedData) => {
          console.log('Template saved:', savedData);
        },
        onError: (error) => {
          console.error('Editor error:', error);
        },
        onLoad: (template) => {
          console.log('Template loaded:', template);
        }
      });
    });

    </script>

    ```
  version: 01.30.00
  contact:
    name: API Support
    url: https://firma.com/support
servers:
  - url: https://api.firma.dev/functions/v1/signing-request-api
    description: API de Production - Recommandée (Actuelle)
  - url: https://api.firma.dev/api/v1
    description: API de Production - Prévue
security:
  - ApiKeyAuth: []
tags:
  - name: Company
    description: Informations et paramètres de l'entreprise
  - name: Workspaces
    description: Opérations de gestion des Espaces de Travail
  - name: Templates
    description: Opérations de gestion des Modèles
  - name: Signing Requests
    description: Opérations de Demande de Signature de documents
  - name: Custom Fields
    description: >-
      Gestion des définitions de champs personnalisés pour les espaces de
      travail, modèles et demandes de signature
  - name: Webhooks
    description: Configuration et gestion des webhooks
  - name: JWT Management
    description: Génération et révocation de jetons JWT pour les modèles intégrés
  - name: Workspace Settings
    description: Configuration et paramètres de l'espace de travail
  - name: Email Domains
    description: >-
      Configuration et vérification de domaine e-mail pour l'envoi d'e-mails de
      demande de signature depuis des domaines personnalisés
  - name: Email Templates
    description: >-
      Gestion des modèles d'e-mail pour la personnalisation des notifications de
      demande de signature au niveau de l'espace de travail et de l'entreprise
  - name: Signer Terms
    description: >-
      Conditions d'utilisation / déclarations de consentement personnalisées
      pour le signataire, au niveau de l'entreprise avec des surcharges par
      espace de travail et par langue
paths:
  /workspaces/{id}:
    put:
      tags:
        - Workspaces
      summary: Mettre à jour un espace de travail
      description: >-
        Met à jour les informations d'un espace de travail existant. Il s'agit
        d'une opération de remplacement complet nécessitant le champ name.
      operationId: updateWorkspace
      parameters:
        - name: id
          in: path
          required: true
          description: ID de l'espace de travail
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  description: Nom de l'espace de travail
                  maxLength: 255
            example:
              name: Enterprise Sales Workspace
      responses:
        '200':
          description: Espace de travail mis à jour avec succès
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Limite de requêtes : 120 requêtes par minute'
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Nombre de requêtes restantes dans la fenêtre actuelle
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Timestamp Unix de réinitialisation de la limite de requêtes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: TypeScript
          label: '@firma-dev/sdk'
          source: |-
            import { FirmaClient } from "@firma-dev/sdk";

            const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

            const response = await firma.workspaces.updateWorkspace({
                id: "id",
                name: "Enterprise Sales Workspace"
            });
            console.log(response);
components:
  schemas:
    Workspace:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique de l'espace de travail
        name:
          type: string
          description: Nom de l'espace de travail
          maxLength: 255
        protected:
          type: boolean
          description: Les espaces de travail protégés ne peuvent pas être supprimés
        api_key:
          type: string
          description: >-
            Clé API en mode production pour cet espace de travail. Utilisée pour
            authentifier les requêtes API propres à cet espace de travail.
          nullable: true
        test_api_key:
          type: string
          description: >-
            Clé API en mode test pour cet espace de travail. Les requêtes
            authentifiées avec cette clé ne consomment pas de crédits et
            produisent des demandes de signature marquées test et filigranées.
          nullable: true
        created_date:
          type: string
          format: date-time
          description: Timestamp de création de l'espace de travail
        updated_date:
          type: string
          format: date-time
          description: Timestamp de dernière mise à jour de l'espace de travail
        webhook_enabled:
          type: boolean
          description: >-
            Indique si les webhooks au niveau de l'espace de travail sont
            activés
        webhook_secret:
          type: string
          description: Secret de signature webhook pour cet espace de travail
          nullable: true
        webhook_secret_rotated_at:
          type: string
          format: date-time
          description: Timestamp de la dernière rotation du secret webhook
          nullable: true
        webhook_secret_created_at:
          type: string
          format: date-time
          description: Timestamp de la première création du secret webhook
          nullable: true
        ignore_company_webhooks:
          type: boolean
          description: >-
            Si true, les webhooks au niveau de l'entreprise ne se déclenchent
            pas pour les événements de cet espace de travail
        icon_url:
          type: string
          format: uri
          description: >-
            URL publiquement accessible vers le logo de l'espace de travail.
            Retourne le logo propre à l'espace de travail, ou null s'il n'est
            pas défini (le logo de l'entreprise n'est PAS inclus comme solution
            de repli dans ce champ).
          nullable: true
          example: >-
            https://ielmshcswdhuacyjlpiy.supabase.co/functions/v1/logo/workspace/company-id/workspace-id
      required:
        - id
        - name
        - created_date
    Error:
      type: object
      properties:
        error:
          type: string
          description: Message d'erreur lisible par un humain
        message:
          type: string
          description: Description détaillée de l'erreur
        details:
          type: object
          description: Détails d'erreur supplémentaires
          additionalProperties: true
      required:
        - error
  responses:
    ValidationError:
      description: Requête Incorrecte - Échec de la validation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Validation Error
            message: Invalid input data
            details:
              name: Name is required
              email: Invalid email format
    UnauthorizedError:
      description: Non Autorisé - Clé API invalide ou manquante
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
            message: Invalid API key
    NotFoundError:
      description: Non Trouvé - La ressource n'existe pas
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not Found
            message: The requested resource was not found
    RateLimitError:
      description: Trop de requêtes - Limite de débit dépassée
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Nombre maximum de requêtes par minute
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requêtes restantes
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Timestamp Unix de la réinitialisation
        Retry-After:
          schema:
            type: integer
          description: Secondes avant de pouvoir réessayer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Rate Limit Exceeded
            message: Too many requests. Please wait before retrying.
            details:
              retry_after: 45
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Clé API pour l'authentification. Utilisez votre clé API directement sans
        préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel
        mais pas obligatoire.

````