> ## 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 les paramètres de l'espace de travail

> Met à jour les paramètres de l'espace de travail



## OpenAPI

````yaml api-reference/v01.30.00/openapi-v01.30.00.fr.json put /workspace/{workspace_id}/settings
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:
  /workspace/{workspace_id}/settings:
    put:
      tags:
        - Workspace Settings
      summary: Mettre à jour les paramètres de l'espace de travail
      description: Met à jour les paramètres de l'espace de travail
      operationId: updateWorkspaceSettings
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                signing_request_email_header:
                  type: string
                signing_request_email_body:
                  type: string
                team_email:
                  type: string
                  format: email
                timezone:
                  type: string
                language:
                  type: string
                  enum:
                    - en
                    - es
                    - it
                    - pt
                    - fr
                    - de
                    - el
                    - ru
                    - pl
                  description: Langue de l'espace de travail pour les modèles d'email
                show_credit_cost_in_editor:
                  type: boolean
                  description: >-
                    Indique s'il faut afficher le coût en crédits dans les
                    éditeurs intégrés
                require_otp_verification:
                  type: boolean
                  nullable: true
                  description: >-
                    Indique si les signataires doivent vérifier leur email via
                    OTP. null = hérite de l'entreprise
                require_terms_acceptance:
                  type: boolean
                  nullable: true
                  description: >-
                    Indique si les signataires doivent accepter les conditions
                    avant de signer. null hérite du paramètre au niveau de
                    l'entreprise.
                disable_guided_navigation:
                  type: boolean
                  nullable: true
                  description: >-
                    Désactive le défilement automatique vers le prochain champ
                    requis pendant la signature. Hérite de l'espace de travail
                    ou de l'entreprise si non défini.
                show_signature_frame:
                  type: boolean
                  nullable: true
                  description: >-
                    Indique s'il faut afficher les cadres de signature dans les
                    PDF terminés. null = hérite de l'entreprise
                color_primary:
                  type: string
                  nullable: true
                  description: >-
                    Remplacement de la couleur principale (hex #rrggbb). Null
                    pour hériter de l'entreprise.
                color_primary_fg:
                  type: string
                  nullable: true
                  description: >-
                    Surcharge de la couleur de premier plan principale. Null
                    pour hériter de l'entreprise.
                color_background:
                  type: string
                  nullable: true
                  description: >-
                    Surcharge de la couleur d'arrière-plan. Null pour hériter de
                    l'entreprise.
                color_foreground:
                  type: string
                  nullable: true
                  description: >-
                    Surcharge de la couleur de premier plan/texte. Null pour
                    hériter de l'entreprise.
                color_card:
                  type: string
                  nullable: true
                  description: >-
                    Surcharge de la couleur d'arrière-plan des cartes. Null pour
                    hériter de l'entreprise.
                color_border:
                  type: string
                  nullable: true
                  description: >-
                    Surcharge de la couleur de bordure. Null pour hériter de
                    l'entreprise.
                color_accent:
                  type: string
                  nullable: true
                  description: >-
                    Couleur d'accent de l'interface de l'éditeur. Null pour
                    hériter de l'entreprise.
                color_accent_fg:
                  type: string
                  nullable: true
                  description: >-
                    Couleur de premier plan sur les surfaces d'accent. Null pour
                    hériter de l'entreprise.
                color_canvas:
                  type: string
                  nullable: true
                  description: >-
                    Couleur du pourtour du canevas de document dans l'éditeur.
                    Null pour hériter de l'entreprise.
                color_muted:
                  type: string
                  nullable: true
                  description: >-
                    Couleur de surface atténuée. Null pour hériter de
                    l'entreprise.
                color_muted_fg:
                  type: string
                  nullable: true
                  description: >-
                    Couleur de texte atténuée. Null pour hériter de
                    l'entreprise.
                email_local_part:
                  type: string
                  nullable: true
                  description: >-
                    La partie locale (avant le @) de l'adresse email de
                    l'expéditeur. Null pour hériter du paramètre de
                    l'entreprise.
                  pattern: ^[a-z0-9]([a-z0-9._-]*[a-z0-9])?$
                  minLength: 1
                  maxLength: 64
                allow_presigning_download:
                  type: boolean
                  nullable: true
                  description: >-
                    Autoriser les signataires à télécharger le document original
                    avant de signer. Hérite du paramètre de l'espace de travail
                    ou de l'entreprise quand null.
                show_partial_watermark:
                  type: boolean
                  nullable: true
                  description: >-
                    Afficher un filigrane EN COURS sur les téléchargements PDF
                    partiels lorsque tous les signataires n'ont pas terminé.
                    null hérite du paramètre au niveau de l'entreprise.
                show_qr_code:
                  type: boolean
                  nullable: true
                  description: >-
                    Afficher un code QR sur la page de signature permettant aux
                    signataires de continuer sur leur téléphone. Hérite du
                    paramètre de l'espace de travail ou de l'entreprise quand
                    null.
                signing_button_label_overrides:
                  type: object
                  nullable: true
                  description: >-
                    Libellés de boutons personnalisés par langue pour la vue de
                    signature. Les clés sont des codes de langue (en, de, etc.)
                    ; les valeurs sont des objets associant des clés de
                    traduction à un texte personnalisé. Null pour utiliser les
                    valeurs par défaut.
                  additionalProperties:
                    type: object
                    additionalProperties:
                      type: string
      responses:
        '200':
          description: Paramètres de l'espace de travail mis à jour avec succès
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Limite de débit : 120 requêtes par minute'
            X-RateLimit-Remaining:
              schema:
                type: integer
            X-RateLimit-Reset:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceSettings'
        '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.workspaceSettings.updateWorkspaceSettings({
                workspace_id: "workspace_id"
            });

            console.log(response);
components:
  schemas:
    WorkspaceSettings:
      type: object
      properties:
        workspace_id:
          type: string
          format: uuid
        name:
          type: string
          description: Nom de l'espace de travail
        team_email:
          type: string
          format: email
          description: Email de contact de l'espace de travail
        timezone:
          type: string
          description: Fuseau horaire de l'espace de travail
        language:
          type: string
          description: Langue de l'espace de travail pour les modèles d'email
          enum:
            - en
            - es
            - it
            - pt
            - fr
            - de
            - el
            - ru
            - pl
          default: en
        signing_request_email_header:
          type: string
          description: Texte d'en-tête d'email personnalisé
        signing_request_email_body:
          type: string
          description: Corps d'email HTML personnalisé
        show_credit_cost_in_editor:
          type: boolean
          description: >-
            Indique s'il faut afficher le coût en crédits dans les éditeurs
            intégrés de modèles et de demandes de signature
          default: true
        require_otp_verification:
          type: boolean
          nullable: true
          description: >-
            Indique si les signataires doivent vérifier leur email via OTP avant
            d'accéder aux documents. null = hériter du paramètre de
            l'entreprise, true = exiger l'OTP, false = ne pas exiger l'OTP
        require_terms_acceptance:
          type: boolean
          nullable: true
          description: >-
            Indique si les signataires doivent accepter les conditions avant de
            signer. null hérite du paramètre au niveau de l'entreprise.
        disable_guided_navigation:
          type: boolean
          nullable: true
          description: >-
            Désactiver le défilement automatique vers le prochain champ
            obligatoire pendant la signature. Hérite de l'espace de travail ou
            de l'entreprise si non défini.
        show_signature_frame:
          type: boolean
          nullable: true
          description: >-
            Indique s'il faut afficher un cadre visuel avec l'ID de Signature
            autour des signatures dans les PDF finalisés. null = hériter du
            paramètre de l'entreprise (activé par défaut), true = afficher le
            cadre, false = masquer le cadre
        allow_presigning_download:
          type: boolean
          nullable: true
          description: >-
            Autoriser les signataires à télécharger le document original avant
            de signer. null hérite du paramètre au niveau de l'entreprise.
        show_partial_watermark:
          type: boolean
          nullable: true
          description: >-
            Afficher un filigrane EN COURS sur les téléchargements de PDF
            partiels lorsque tous les signataires n'ont pas terminé. null hérite
            du paramètre au niveau de l'entreprise.
        show_qr_code:
          type: boolean
          nullable: true
          description: >-
            Afficher un QR code sur la page de signature permettant aux
            signataires de continuer sur leur téléphone. null hérite du
            paramètre au niveau de l'entreprise.
        color_primary:
          type: string
          nullable: true
          description: >-
            Couleur primaire personnalisée (hex #rrggbb). Null pour hériter de
            l'entreprise.
          example: '#2563eb'
        color_primary_fg:
          type: string
          nullable: true
          description: Couleur de premier plan primaire personnalisée. Null pour hériter.
          example: '#ffffff'
        color_background:
          type: string
          nullable: true
          description: Couleur d'arrière-plan personnalisée. Null pour hériter.
          example: '#0f172a'
        color_foreground:
          type: string
          nullable: true
          description: Couleur de premier plan/texte personnalisée. Null pour hériter.
          example: '#ffffff'
        color_card:
          type: string
          nullable: true
          description: Couleur d'arrière-plan des cartes personnalisée. Null pour hériter.
          example: '#22222a'
        color_border:
          type: string
          nullable: true
          description: Couleur de bordure personnalisée. Null pour hériter.
          example: '#3b3b3b'
        color_accent:
          type: string
          nullable: true
          description: Couleur d'accent de l'interface de l'éditeur. Null pour hériter.
          example: '#34eeff'
        color_accent_fg:
          type: string
          nullable: true
          description: >-
            Couleur de premier plan sur les surfaces d'accent. Null pour
            hériter.
          example: '#000000'
        color_canvas:
          type: string
          nullable: true
          description: >-
            Couleur de l'entourage du canevas de document dans l'éditeur. Null
            pour hériter.
          example: '#0f1419'
        color_muted:
          type: string
          nullable: true
          description: Couleur de surface atténuée. Null pour hériter.
          example: '#22222a'
        color_muted_fg:
          type: string
          nullable: true
          description: Couleur de texte atténuée. Null pour hériter.
          example: '#b8b8b8'
        email_local_part:
          type: string
          nullable: true
          description: >-
            La partie locale (avant le @) de l'adresse email de l'expéditeur.
            Null pour hériter du paramètre de l'entreprise. S'applique
            uniquement quand un domaine personnalisé vérifié est configuré.
          example: signatures
          pattern: ^[a-z0-9]([a-z0-9._-]*[a-z0-9])?$
          minLength: 1
          maxLength: 64
        signing_button_label_overrides:
          type: object
          nullable: true
          description: >-
            Libellés de boutons personnalisés par langue pour la vue de
            signature. Les clés sont des codes de langue (en, de, etc.) ; les
            valeurs sont des objets associant des clés de traduction à un texte
            personnalisé. Null pour utiliser les valeurs par défaut.
          additionalProperties:
            type: object
            additionalProperties:
              type: string
      required:
        - workspace_id
    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.

````