> ## 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.

# Actualizar configuración del espacio de trabajo

> Actualiza la configuración del espacio de trabajo



## OpenAPI

````yaml api-reference/v01.30.00/openapi-v01.30.00.es.json put /workspace/{workspace_id}/settings
openapi: 3.0.3
info:
  title: API de Socios de Firma
  description: >-
    API RESTful para firma de documentos y gestión de plantillas.


    **Autenticación**: Todos los endpoints requieren autenticación mediante
    clave API a través del encabezado `Authorization`. Usa tu clave API
    directamente sin ningún prefijo (por ejemplo, `your-api-key`). El prefijo
    Bearer es opcional pero no obligatorio.


    **Características de Seguridad**:

    - Validación de entrada usando esquemas Zod con mensajes de error detallados
    a nivel de campo

    - Tokens JWT firmados con RSA-256 para el acceso al Editor de Plantillas
    incrustado


    **Límite de Solicitudes**: Los límites de solicitudes están escalonados
    según el tipo de operación:

    - Operaciones de lectura (GET): 200 solicitudes por minuto

    - Operaciones de escritura (POST/PUT/PATCH/DELETE): 120 solicitudes por
    minuto

    - Operaciones CRUD de webhooks: 60 solicitudes por minuto

    - Prueba de webhook: 10 solicitudes por minuto

    - Regeneración/expiración de clave API: 1 solicitud por minuto

    - Rotación de secreto de webhook: 1 solicitud por minuto


    Cuando se superan los límites de solicitudes, la API devuelve una respuesta
    `429 Too Many Requests` con los encabezados:

    - `X-RateLimit-Limit`: Máximo de solicitudes por minuto para este endpoint

    - `X-RateLimit-Remaining`: Solicitudes restantes en la ventana actual

    - `X-RateLimit-Reset`: Marca de tiempo Unix de cuándo se restablece el
    límite

    - `Retry-After`: Segundos hasta que se permita reintentar


    **Manejo de Errores**: Todos los errores devuelven respuestas JSON
    estructuradas con `error` (mensaje legible para humanos), `code`
    (identificador legible por máquina) y `details` (errores de validación a
    nivel de campo cuando corresponda).


    **Integración del Editor de Plantillas Incrustado**: El Editor de Plantillas
    de Firma se puede incrustar en tu aplicación usando una biblioteca
    JavaScript independiente.


    ```html

    <!-- Carga la biblioteca del Editor de Plantillas de Firma -->

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


    <script>

    // Genera el token JWT vía API primero

    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 => {
      // Inicializa el editor con el token 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 Producción - Recomendada (Actual)
  - url: https://api.firma.dev/api/v1
    description: API de Producción - Planeada
security:
  - ApiKeyAuth: []
tags:
  - name: Company
    description: Información y configuración de la empresa
  - name: Workspaces
    description: Operaciones de gestión de espacios de trabajo
  - name: Templates
    description: Operaciones de gestión de plantillas
  - name: Signing Requests
    description: Operaciones de solicitudes de firma de documentos
  - name: Custom Fields
    description: >-
      Gestión de definiciones de campos personalizados para espacios de trabajo,
      plantillas y solicitudes de firma
  - name: Webhooks
    description: Configuración y gestión de webhooks
  - name: JWT Management
    description: Generación y revocación de tokens JWT para plantillas incrustadas
  - name: Workspace Settings
    description: Configuración y ajustes del espacio de trabajo
  - name: Email Domains
    description: >-
      Configuración y verificación de dominios de correo electrónico para enviar
      correos de solicitudes de firma desde dominios personalizados
  - name: Email Templates
    description: >-
      Gestión de plantillas de correo electrónico para personalización de
      notificaciones de solicitudes de firma a nivel de espacio de trabajo y de
      empresa
  - name: Signer Terms
    description: >-
      Términos de servicio / declaraciones de consentimiento personalizadas del
      firmante, a nivel de empresa con anulaciones por espacio de trabajo según
      el idioma
paths:
  /workspace/{workspace_id}/settings:
    put:
      tags:
        - Workspace Settings
      summary: Actualizar configuración del espacio de trabajo
      description: Actualiza la configuración del espacio de trabajo
      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: Idioma del espacio de trabajo para las plantillas de correo
                show_credit_cost_in_editor:
                  type: boolean
                  description: >-
                    Si se debe mostrar el costo en créditos en los editores
                    incrustados
                require_otp_verification:
                  type: boolean
                  nullable: true
                  description: >-
                    Si los firmantes deben verificar su correo mediante OTP.
                    null = heredar de la empresa
                require_terms_acceptance:
                  type: boolean
                  nullable: true
                  description: >-
                    Si los firmantes deben aceptar los términos antes de firmar.
                    null hereda la configuración a nivel de empresa.
                disable_guided_navigation:
                  type: boolean
                  nullable: true
                  description: >-
                    Desactiva el desplazamiento automático al siguiente campo
                    requerido durante la firma. Hereda del espacio de trabajo o
                    de la empresa si no se establece.
                show_signature_frame:
                  type: boolean
                  nullable: true
                  description: >-
                    Si se deben renderizar los marcos de firma en los PDF
                    completados. null = heredar de la empresa
                color_primary:
                  type: string
                  nullable: true
                  description: >-
                    Color primario personalizado (hex #rrggbb). Null para
                    heredar de la empresa.
                color_primary_fg:
                  type: string
                  nullable: true
                  description: >-
                    Anulación del color de primer plano primario. Null para
                    heredar de la empresa.
                color_background:
                  type: string
                  nullable: true
                  description: >-
                    Anulación del color de fondo. Null para heredar de la
                    empresa.
                color_foreground:
                  type: string
                  nullable: true
                  description: >-
                    Anulación del color de primer plano/texto. Null para heredar
                    de la empresa.
                color_card:
                  type: string
                  nullable: true
                  description: >-
                    Anulación del color de fondo de la tarjeta. Null para
                    heredar de la empresa.
                color_border:
                  type: string
                  nullable: true
                  description: >-
                    Anulación del color del borde. Null para heredar de la
                    empresa.
                color_accent:
                  type: string
                  nullable: true
                  description: >-
                    Color de acento de la interfaz del editor. Null para heredar
                    de la empresa.
                color_accent_fg:
                  type: string
                  nullable: true
                  description: >-
                    Color de primer plano en superficies de acento. Null para
                    heredar de la empresa.
                color_canvas:
                  type: string
                  nullable: true
                  description: >-
                    Color del entorno del lienzo del documento en el editor.
                    Null para heredar de la empresa.
                color_muted:
                  type: string
                  nullable: true
                  description: >-
                    Color de superficie atenuado. Null para heredar de la
                    empresa.
                color_muted_fg:
                  type: string
                  nullable: true
                  description: Color de texto atenuado. Null para heredar de la empresa.
                email_local_part:
                  type: string
                  nullable: true
                  description: >-
                    La parte local (antes del @) de la dirección de correo del
                    remitente. Null para heredar de la configuración de la
                    empresa.
                  pattern: ^[a-z0-9]([a-z0-9._-]*[a-z0-9])?$
                  minLength: 1
                  maxLength: 64
                allow_presigning_download:
                  type: boolean
                  nullable: true
                  description: >-
                    Permite a los firmantes descargar el documento original
                    antes de firmar. Hereda de la configuración del espacio de
                    trabajo o de la empresa cuando es null.
                show_partial_watermark:
                  type: boolean
                  nullable: true
                  description: >-
                    Muestra una marca de agua de EN PROGRESO en las descargas
                    parciales de PDF cuando no todos los firmantes han
                    completado. null hereda la configuración a nivel de empresa.
                show_qr_code:
                  type: boolean
                  nullable: true
                  description: >-
                    Muestra un código QR en la página de firma que permite a los
                    firmantes continuar desde su teléfono. Hereda de la
                    configuración del espacio de trabajo o de la empresa cuando
                    es null.
                signing_button_label_overrides:
                  type: object
                  nullable: true
                  description: >-
                    Etiquetas de botón personalizadas por idioma para la vista
                    de firma. Las claves son códigos de idioma (en, de, etc.);
                    los valores son objetos que mapean claves de traducción a
                    texto personalizado. Null para usar los valores
                    predeterminados.
                  additionalProperties:
                    type: object
                    additionalProperties:
                      type: string
      responses:
        '200':
          description: Configuración del espacio de trabajo actualizada correctamente
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Límite de tasa: 120 solicitudes por minuto'
            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: Nombre del espacio de trabajo
        team_email:
          type: string
          format: email
          description: Correo electrónico de contacto del espacio de trabajo
        timezone:
          type: string
          description: Zona horaria del espacio de trabajo
        language:
          type: string
          description: >-
            Idioma del espacio de trabajo para las plantillas de correo
            electrónico
          enum:
            - en
            - es
            - it
            - pt
            - fr
            - de
            - el
            - ru
            - pl
          default: en
        signing_request_email_header:
          type: string
          description: Texto de encabezado de correo electrónico personalizado
        signing_request_email_body:
          type: string
          description: Cuerpo de correo electrónico HTML personalizado
        show_credit_cost_in_editor:
          type: boolean
          description: >-
            Indica si se debe mostrar el costo en créditos en los editores
            incrustados de plantillas y solicitudes de firma
          default: true
        require_otp_verification:
          type: boolean
          nullable: true
          description: >-
            Indica si los firmantes deben verificar su correo electrónico
            mediante OTP antes de acceder a los documentos. null = heredar de la
            configuración de la empresa, true = requerir OTP, false = no
            requerir OTP
        require_terms_acceptance:
          type: boolean
          nullable: true
          description: >-
            Indica si los firmantes deben aceptar los términos antes de firmar.
            null hereda la configuración a nivel de empresa.
        disable_guided_navigation:
          type: boolean
          nullable: true
          description: >-
            Desactiva el desplazamiento automático hacia el siguiente campo
            requerido durante la firma. Hereda del espacio de trabajo o de la
            empresa si no está definido.
        show_signature_frame:
          type: boolean
          nullable: true
          description: >-
            Indica si se debe mostrar un marco visual con el ID de Firma
            alrededor de las firmas en los PDF completados. null = heredar de la
            configuración de la empresa (habilitado por defecto), true = mostrar
            marco, false = ocultar marco
        allow_presigning_download:
          type: boolean
          nullable: true
          description: >-
            Permite a los firmantes descargar el documento original antes de
            firmar. null hereda la configuración a nivel de empresa.
        show_partial_watermark:
          type: boolean
          nullable: true
          description: >-
            Muestra una marca de agua de EN PROGRESO en las descargas parciales
            del PDF cuando no todos los firmantes han completado el proceso.
            null hereda la configuración a nivel de empresa.
        show_qr_code:
          type: boolean
          nullable: true
          description: >-
            Muestra un código QR en la página de firma que permite a los
            firmantes continuar desde su teléfono. null hereda la configuración
            a nivel de empresa.
        color_primary:
          type: string
          nullable: true
          description: >-
            Anulación del color primario (hex #rrggbb). Null para heredar de la
            empresa.
          example: '#2563eb'
        color_primary_fg:
          type: string
          nullable: true
          description: Anulación del color primario de primer plano. Null para heredar.
          example: '#ffffff'
        color_background:
          type: string
          nullable: true
          description: Anulación del color de fondo. Null para heredar.
          example: '#0f172a'
        color_foreground:
          type: string
          nullable: true
          description: Anulación del color de primer plano/texto. Null para heredar.
          example: '#ffffff'
        color_card:
          type: string
          nullable: true
          description: Anulación del color de fondo de las tarjetas. Null para heredar.
          example: '#22222a'
        color_border:
          type: string
          nullable: true
          description: Anulación del color del borde. Null para heredar.
          example: '#3b3b3b'
        color_accent:
          type: string
          nullable: true
          description: Color de acento de la interfaz del editor. Null para heredar.
          example: '#34eeff'
        color_accent_fg:
          type: string
          nullable: true
          description: Color de primer plano en superficies de acento. Null para heredar.
          example: '#000000'
        color_canvas:
          type: string
          nullable: true
          description: >-
            Color del entorno del lienzo de documento del editor. Null para
            heredar.
          example: '#0f1419'
        color_muted:
          type: string
          nullable: true
          description: Color de superficie atenuado. Null para heredar.
          example: '#22222a'
        color_muted_fg:
          type: string
          nullable: true
          description: Color de texto atenuado. Null para heredar.
          example: '#b8b8b8'
        email_local_part:
          type: string
          nullable: true
          description: >-
            La parte local (antes de la @) de la dirección de correo del
            remitente. Null para heredar de la configuración de la empresa. Solo
            aplica cuando hay un dominio personalizado verificado configurado.
          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: >-
            Etiquetas de botón personalizadas por idioma para la vista de firma.
            Las claves son códigos de idioma (en, de, etc.); los valores son
            objetos que asignan claves de traducción a texto personalizado. Null
            para usar los valores predeterminados.
          additionalProperties:
            type: object
            additionalProperties:
              type: string
      required:
        - workspace_id
    Error:
      type: object
      properties:
        error:
          type: string
          description: Mensaje de error legible para humanos
        message:
          type: string
          description: Descripción detallada del error
        details:
          type: object
          description: Detalles adicionales del error
          additionalProperties: true
      required:
        - error
  responses:
    ValidationError:
      description: Solicitud Incorrecta - La validación falló
      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: No Autorizado - Clave API inválida o faltante
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
            message: Invalid API key
    NotFoundError:
      description: No Encontrado - El recurso no existe
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not Found
            message: The requested resource was not found
    RateLimitError:
      description: Demasiadas Solicitudes - Se superó el límite de solicitudes
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Número máximo de solicitudes por minuto
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Solicitudes restantes
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Marca de tiempo Unix del reinicio
        Retry-After:
          schema:
            type: integer
          description: Segundos hasta que se permita reintentar
      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: >-
        Clave API para autenticación. Usa tu clave API directamente sin ningún
        prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional
        pero no obligatorio.

````