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

# Duplicate form

> Create a copy of an existing form with all elements, configurations, and settings. Requires site manager permissions.

**Parameters**:
- `id`: Source form identifier to duplicate
- `newName`: Name for the duplicated form (must be unique)
- `newDescription`: Optional description override
- `siteIds`: Target sites for deployment (can differ from source)
- `copySubmissions`: Whether to copy existing submission data (default: false)

**Duplication includes**:
- All form elements with identical configurations
- Conditional logic and element dependencies
- Validation rules and constraints
- File upload settings and restrictions
- Public access and security settings
- Custom metadata and categorization

**Customization Options**:
- Modify site deployment during duplication
- Update form metadata while preserving structure
- Choose whether to inherit submission data
- Adjust period configurations for different timeframes

**Common Use Cases**:
- Creating forms for new reporting periods (annual copies)
- Deploying similar forms to different site groups
- Template creation for standardized data collection
- A/B testing different form configurations
- Backup creation before major modifications
- Regional customization of global forms



## OpenAPI

````yaml https://app.azalt.co/api/v1/openapi.json post /forms/{id}/duplicate
openapi: 3.0.3
info:
  title: Erguvan Public API
  version: 1.0.0
servers:
  - url: https://app.azalt.co/api/v1
security: []
paths:
  /forms/{id}/duplicate:
    post:
      tags:
        - Form
      summary: Duplicate form
      description: >-
        Create a copy of an existing form with all elements, configurations, and
        settings. Requires site manager permissions.


        **Parameters**:

        - `id`: Source form identifier to duplicate

        - `newName`: Name for the duplicated form (must be unique)

        - `newDescription`: Optional description override

        - `siteIds`: Target sites for deployment (can differ from source)

        - `copySubmissions`: Whether to copy existing submission data (default:
        false)


        **Duplication includes**:

        - All form elements with identical configurations

        - Conditional logic and element dependencies

        - Validation rules and constraints

        - File upload settings and restrictions

        - Public access and security settings

        - Custom metadata and categorization


        **Customization Options**:

        - Modify site deployment during duplication

        - Update form metadata while preserving structure

        - Choose whether to inherit submission data

        - Adjust period configurations for different timeframes


        **Common Use Cases**:

        - Creating forms for new reporting periods (annual copies)

        - Deploying similar forms to different site groups

        - Template creation for standardized data collection

        - A/B testing different form configurations

        - Backup creation before major modifications

        - Regional customization of global forms
      operationId: duplicateForm
      parameters:
        - in: path
          name: id
          schema:
            type: string
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                organizationId:
                  type: string
                siteIds:
                  type: array
                  items:
                    type: string
                  minItems: 1
                years:
                  type: array
                  items:
                    type: number
                  minItems: 1
                unitMapping:
                  type: object
                  additionalProperties:
                    anyOf:
                      - type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - existing
                          unitId:
                            type: string
                        required:
                          - type
                          - unitId
                      - type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - create
                          unitName:
                            type: string
                        required:
                          - type
                          - unitName
              required:
                - siteIds
                - years
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  description:
                    type: string
                    nullable: true
                  isPublic:
                    type: boolean
                required:
                  - id
                  - name
                  - description
                  - isPublic
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - Authorization: []
components:
  schemas:
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````