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

# Update a form

> Updates a form. This is a partial update: any fields omitted from the request body are left unchanged.




## OpenAPI

````yaml openapi-forms PUT /api/forms/{form_id}
openapi: 3.0.0
info:
  title: Paubox Forms API
  description: >
    The Paubox Forms API has two kinds of endpoints. Public, respondent-facing
    endpoints (retrieving a form definition for rendering and submitting a form
    response) require no authentication. Authenticated management endpoints
    (creating, listing, updating, copying, archiving forms, and reading or
    exporting submissions) require a Paubox API key with the "forms" scope, sent
    as `Authorization: Bearer YOUR_API_KEY`. API keys are generated in the
    Paubox dashboard.
  version: 1.0.0
servers:
  - url: https://api.paubox.com/v1/forms
    description: Paubox Forms API
security: []
tags:
  - name: Forms
    description: Retrieve form definitions and accept submissions
  - name: Form management
    description: Create, list, update, copy, and archive forms (requires API key)
  - name: Submissions
    description: List and export form submissions (requires API key)
paths:
  /api/forms/{form_id}:
    put:
      tags:
        - Form management
      summary: Update a form
      description: >
        Updates a form. This is a partial update: any fields omitted from the
        request body are left unchanged.
      operationId: updateForm
      parameters:
        - name: form_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID of the form to update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFormRequest'
            examples:
              example:
                summary: Rename and activate a form
                value:
                  title: Patient Intake Form (2024)
                  active: true
      responses:
        '200':
          description: Form updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  form_id:
                    type: string
                    format: uuid
              examples:
                example:
                  summary: Example response
                  value:
                    detail: Form updated successfully
                    form_id: 550e8400-e29b-41d4-a716-446655440000
        '401':
          description: Missing or invalid API key, or the key lacks the "forms" scope
        '403':
          description: The form belongs to a different customer
        '404':
          description: Form not found or deleted
      security:
        - bearerAuth: []
components:
  schemas:
    UpdateFormRequest:
      type: object
      description: >
        Partial update. All fields are optional; omitted fields are left
        unchanged.
      properties:
        title:
          type: string
        description:
          type: string
        form_json:
          type: object
          description: The form field schema
        vanity_url:
          type: string
        recipient:
          type: string
          description: |
            Comma-separated email addresses notified on each submission.
        active:
          type: boolean
        subscription_list_id:
          type: string
          description: >
            ID of the connected Marketing contact list. For marketing forms, new
            subscribers are added to this list.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Paubox API key sent as `Authorization: Bearer YOUR_API_KEY`. API keys
        are created in the Paubox dashboard and must have the "forms" scope; a
        key without the forms scope receives 401 Unauthorized. A valid key used
        against a resource that belongs to a different customer receives 403
        Forbidden.

````