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

# Partially Update Template

> Update template properties, a single user, OR a single field. Cannot mix multiple entity types in one request. Use PUT for comprehensive updates including users, fields, and reminders.



## OpenAPI

````yaml api-reference/v01.12.00/openapi-v01.12.00.json patch /templates/{id}
openapi: 3.0.3
info:
  title: Firma Partner API
  description: >-
    RESTful API for document signing and template management.


    **Authentication**: All endpoints require API key authentication via the
    `Authorization` header. Use your API key directly without any prefix (e.g.,
    `your-api-key`). The Bearer prefix is optional but not required.


    **Security Features**:

    - Input validation using Zod schemas with detailed field-level error
    messages

    - RSA-256 signed JWT tokens for embedded template access


    **Rate Limiting**: Rate limits are tiered based on operation type:

    - Read operations (GET): 200 requests per minute

    - Write operations (POST/PUT/PATCH/DELETE): 120 requests per minute

    - Webhook CRUD operations: 60 requests per minute

    - Webhook test: 10 requests per minute

    - API key regeneration/expiration: 1 request per minute

    - Webhook secret rotation: 1 request per minute


    When rate limits are exceeded, the API returns a `429 Too Many Requests`
    response with headers:

    - `X-RateLimit-Limit`: Maximum requests per minute for this endpoint

    - `X-RateLimit-Remaining`: Requests remaining in current window

    - `X-RateLimit-Reset`: Unix timestamp when limit resets

    - `Retry-After`: Seconds until retry is allowed


    **Error Handling**: All errors return structured JSON responses with `error`
    (human-readable message), `code` (machine-readable identifier), and
    `details` (field-level validation errors when applicable).


    **Embedded Template Integration**: The Firma Template Editor can be embedded
    in your application using a standalone JavaScript library.


    ```html

    <!-- Load the Firma Template Editor library -->

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


    <script>

    // Generate JWT token via API first

    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 => {
      // Initialize editor with JWT token
      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);
        }
      });
    });

    ```
  version: 01.12.00
  contact:
    name: API Support
    url: https://firma.com/support
servers:
  - url: https://api.firma.dev/functions/v1/signing-request-api
    description: Production API - Recommended (Current)
  - url: https://api.firma.dev/api/v1
    description: Production API - Planned
security:
  - ApiKeyAuth: []
tags:
  - name: Company
    description: Company information and settings
  - name: Workspaces
    description: Workspace management operations
  - name: Templates
    description: Template management operations
  - name: Signing Requests
    description: Document signing request operations
  - name: Custom Fields
    description: >-
      Custom field definition management for workspaces, templates, and signing
      requests
  - name: Webhooks
    description: Webhook configuration and management
  - name: JWT Management
    description: JWT token generation and revocation for embedded templates
  - name: Workspace Settings
    description: Workspace configuration and settings
  - name: Email Domains
    description: >-
      Email domain setup and verification for sending signing request emails
      from custom domains
  - name: Email Templates
    description: >-
      Email template management for workspace and company-level customization of
      signing request notifications
  - name: Legacy
    description: Deprecated endpoints maintained for backward compatibility
paths:
  /templates/{id}:
    patch:
      tags:
        - Templates
      summary: Partially Update Template
      description: >-
        Update template properties, a single user, OR a single field. Cannot mix
        multiple entity types in one request. Use PUT for comprehensive updates
        including users, fields, and reminders.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  description: Update template properties
                  properties:
                    name:
                      type: string
                      description: Template name
                      maxLength: 255
                    description:
                      type: string
                      description: Template description
                    document:
                      type: string
                      format: byte
                      description: >-
                        Base64-encoded PDF or DOCX to replace document. DOCX
                        files are automatically converted to PDF. Maximum size:
                        20MB
                    expiration_hours:
                      type: integer
                      minimum: 1
                      description: Hours until expiration
                    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
                - type: object
                  description: Update or create a single user
                  required:
                    - user
                  properties:
                    user:
                      type: object
                      required:
                        - first_name
                        - email
                        - designation
                        - order
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Include to update existing user, omit to create new
                        first_name:
                          type: string
                          maxLength: 255
                        last_name:
                          type: string
                          maxLength: 255
                          description: >-
                            Optional, but required if using full_name or
                            last_name prefilled variables
                        email:
                          type: string
                          format: email
                        designation:
                          type: string
                          enum:
                            - Signer
                        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: Update or create a single field
                  required:
                    - field
                  properties:
                    field:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Include to update existing field, omit to create new
                        type:
                          type: string
                          enum:
                            - text
                            - signature
                            - date
                            - checkbox
                            - initial
                            - initials
                            - dropdown
                            - radio_buttons
                            - textarea
                            - text_area
                            - url
                            - file
                          description: >-
                            Field type. Accepts 'initial' or 'initials',
                            'textarea' or 'text_area'. Required for new fields.
                            url fields are automatically read-only. file fields
                            allow signers to upload attachments (images/PDF).
                        x:
                          type: number
                          description: X position on document. Required for new fields.
                        'y':
                          type: number
                          description: Y position on document. Required for new fields.
                        width:
                          type: number
                          description: Field width. Required for new fields.
                        height:
                          type: number
                          description: Field height. Required for new fields.
                        page:
                          type: integer
                          minimum: 1
                          description: Page number (1-indexed). Required for new fields.
                        required:
                          type: boolean
                          description: Whether field is required
                        assigned_to_user_id:
                          type: string
                          format: uuid
                          nullable: true
                          description: Template user ID to assign field to
                        variable_name:
                          type: string
                          description: Variable name for prefilled data mapping
                        options:
                          type: array
                          items:
                            type: string
                          description: Options for dropdown fields
                        format_rules:
                          type: object
                          description: >-
                            Format rules (e.g., date format, urlDisplayText for
                            url fields, acceptedFileTypes for file fields)
                        multi_group_id:
                          type: string
                          format: uuid
                          description: Group ID for radio button groups
                        default_to_signing_date:
                          type: boolean
                          description: For date fields, use signing date as default
                        read_only:
                          type: boolean
                          description: >-
                            Whether field is read-only (automatically true for
                            url fields)
                        read_only_value:
                          type: string
                          description: >-
                            Static value for read-only fields. For url fields,
                            this is the URL to link to.
            examples:
              update-properties:
                summary: Update properties
                value:
                  name: Updated Template Name
                  expiration_hours: 72
              create-url-field:
                summary: Create URL field
                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: Create file upload field
                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: Update existing field
                value:
                  field:
                    id: field123-e89b-12d3-a456-426614174000
                    x: 120
                    'y': 220
      responses:
        '200':
          description: Template partially updated successfully
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Rate limit: 120 requests per minute'
            X-RateLimit-Remaining:
              schema:
                type: integer
            X-RateLimit-Reset:
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  updated_fields:
                    type: array
                    items:
                      type: string
                    description: Returned when updating properties
                  user:
                    type: object
                    description: Returned when updating/creating a user
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitError'
      security:
        - ApiKeyAuth: []
components:
  responses:
    ValidationError:
      description: Bad Request - Validation failed
      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: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
            message: Invalid API key
    NotFoundError:
      description: Not Found - Resource does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not Found
            message: The requested resource was not found
    RateLimitError:
      description: Too Many Requests - Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Maximum requests per minute
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix timestamp of reset
        Retry-After:
          schema:
            type: integer
          description: Seconds until retry allowed
      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
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message
        message:
          type: string
          description: Detailed error description
        details:
          type: object
          description: Additional error details
          additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key for authentication. Use your API key directly without any prefix
        (e.g., 'your-api-key'). Bearer prefix is optional but not required.

````