> ## 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 Plantilla Parcialmente

> Actualiza las propiedades de la plantilla, un solo usuario, O un solo campo. No se pueden mezclar múltiples tipos de entidad en una sola solicitud. Usa PUT para actualizaciones integrales que incluyan usuarios, campos y recordatorios.



## OpenAPI

````yaml api-reference/v01.30.00/openapi-v01.30.00.es.json patch /templates/{id}
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:
  /templates/{id}:
    patch:
      tags:
        - Templates
      summary: Actualizar Plantilla Parcialmente
      description: >-
        Actualiza las propiedades de la plantilla, un solo usuario, O un solo
        campo. No se pueden mezclar múltiples tipos de entidad en una sola
        solicitud. Usa PUT para actualizaciones integrales que incluyan
        usuarios, campos y recordatorios.
      operationId: patchTemplate
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  description: Actualizar propiedades de la plantilla
                  properties:
                    name:
                      type: string
                      description: Nombre de la plantilla
                      maxLength: 255
                    description:
                      type: string
                      description: Descripción de la plantilla
                    document:
                      type: string
                      format: byte
                      description: >-
                        PDF o DOCX codificado en Base64 para reemplazar el
                        documento. Los archivos DOCX se convierten
                        automáticamente a PDF. Tamaño máximo: 20MB
                    expiration_hours:
                      type: integer
                      minimum: 1
                      description: Horas hasta la expiración
                    settings:
                      type: object
                      properties:
                        allow_editing_before_sending:
                          type: boolean
                        attach_pdf_on_finish:
                          type: boolean
                        allow_download:
                          type: boolean
                        hand_drawn_only:
                          type: boolean
                        require_otp_verification:
                          type: boolean
                          nullable: true
                        disable_guided_navigation:
                          type: boolean
                          nullable: true
                        allow_presigning_download:
                          type: boolean
                          nullable: true
                          description: >-
                            Permite a los firmantes descargar el documento
                            original antes de firmar. Hereda la configuración
                            del espacio de trabajo o de la empresa cuando es
                            null.
                        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 la configuración del espacio de trabajo o de
                            la empresa cuando es null.
                - type: object
                  description: Actualizar o crear un solo usuario
                  required:
                    - user
                  properties:
                    user:
                      type: object
                      required:
                        - first_name
                        - email
                        - designation
                        - order
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: >-
                            Inclúyelo para actualizar un usuario existente,
                            omítelo para crear uno nuevo
                        first_name:
                          type: string
                          maxLength: 255
                        last_name:
                          type: string
                          maxLength: 255
                          description: >-
                            Opcional, pero requerido si se usan las variables
                            prellenadas full_name o last_name
                        email:
                          type: string
                          format: email
                        designation:
                          type: string
                          enum:
                            - Signer
                            - Approver
                            - CC
                        order:
                          type: integer
                          minimum: 1
                        phone_number:
                          type: string
                        street_address:
                          type: string
                        city:
                          type: string
                        state_province:
                          type: string
                        postal_code:
                          type: string
                        country:
                          type: string
                        title:
                          type: string
                        company:
                          type: string
                - type: object
                  description: Actualizar o crear un solo campo
                  required:
                    - field
                  properties:
                    field:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: >-
                            Inclúyelo para actualizar un campo existente,
                            omítelo para crear uno nuevo
                        type:
                          type: string
                          enum:
                            - text
                            - signature
                            - date
                            - checkbox
                            - initial
                            - initials
                            - dropdown
                            - radio_buttons
                            - textarea
                            - text_area
                            - url
                            - file
                            - stamp
                            - approval_signature
                            - approval_checkmark
                            - approval_date
                          description: >-
                            Tipo de campo. Acepta 'initial' o 'initials',
                            'textarea' o 'text_area'. Requerido para campos
                            nuevos. Los campos url son de solo lectura
                            automáticamente. Los campos file permiten a los
                            firmantes subir archivos adjuntos (imágenes/PDF).
                            Los campos stamp muestran una imagen preconfigurada.
                        x:
                          type: number
                          description: >-
                            Posición X en el documento. Requerido para campos
                            nuevos.
                        'y':
                          type: number
                          description: >-
                            Posición Y en el documento. Requerido para campos
                            nuevos.
                        width:
                          type: number
                          description: Ancho del campo. Requerido para campos nuevos.
                        height:
                          type: number
                          description: Alto del campo. Requerido para campos nuevos.
                        page:
                          type: integer
                          minimum: 1
                          description: >-
                            Número de página (indexado desde 1). Requerido para
                            campos nuevos.
                        required:
                          type: boolean
                          description: Si el campo es obligatorio
                        assigned_to_user_id:
                          type: string
                          format: uuid
                          nullable: true
                          description: >-
                            ID del usuario de la plantilla al que se asigna el
                            campo
                        variable_name:
                          type: string
                          description: >-
                            Nombre de variable para el mapeo de datos
                            prellenados
                        variable_defined_name:
                          type: string
                          maxLength: 100
                          nullable: true
                          description: >-
                            Nombre legible personalizado para la definición del
                            campo. Se puede usar como alternativa a
                            variable_name para apuntar a campos en la creación
                            basada en plantillas.
                        options:
                          type: array
                          items:
                            type: string
                          description: Opciones para campos desplegables
                        format_rules:
                          type: object
                          description: >-
                            Reglas de formato (p. ej., formato de fecha,
                            urlDisplayText para campos url, acceptedFileTypes
                            para campos file)
                        multi_group_id:
                          type: string
                          format: uuid
                          description: ID de grupo para grupos de botones de radio
                        default_to_signing_date:
                          type: boolean
                          description: >-
                            Para campos de fecha, usar la fecha de firma como
                            valor predeterminado
                        read_only:
                          type: boolean
                          description: >-
                            Si el campo es de solo lectura (automáticamente true
                            para campos url)
                        read_only_value:
                          type: string
                          description: >-
                            Valor estático para campos de solo lectura. Para
                            campos url, esta es la URL a la que se enlaza.
            examples:
              update-properties:
                summary: Actualizar propiedades
                value:
                  name: Updated Template Name
                  expiration_hours: 72
              create-url-field:
                summary: Crear campo URL
                value:
                  field:
                    type: url
                    x: 100
                    'y': 200
                    width: 150
                    height: 30
                    page: 1
                    read_only_value: https://example.com/terms
                    format_rules:
                      urlDisplayText: View Terms & Conditions
              create-file-field:
                summary: Crear campo de subida de archivo
                value:
                  field:
                    type: file
                    x: 100
                    'y': 300
                    width: 200
                    height: 40
                    page: 1
                    required: true
                    format_rules:
                      acceptedFileTypes: image_and_pdf
              update-field:
                summary: Actualizar campo existente
                value:
                  field:
                    id: field123-e89b-12d3-a456-426614174000
                    x: 120
                    'y': 220
      responses:
        '200':
          description: Plantilla actualizada parcialmente con éxito
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Límite de solicitudes: 120 solicitudes por minuto'
            X-RateLimit-Remaining:
              schema:
                type: integer
            X-RateLimit-Reset:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplatePatchResponse'
        '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.templates.patchTemplate({
                id: "id",
                body: {
                    name: "Updated Template Name",
                    expiration_hours: 72
                }
            });
            console.log(response);
components:
  schemas:
    TemplatePatchResponse:
      type: object
      properties:
        message:
          type: string
        updated_fields:
          type: array
          items:
            type: string
          description: Se devuelve al actualizar propiedades
        user:
          type: object
          description: Se devuelve al actualizar/crear un usuario
      description: Resultado de la actualización parcial de la plantilla
      required:
        - message
        - updated_fields
    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.

````