> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanova.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Update Form
> Updates a form's name or active status. Requires authentication.
## Overview
Updates a form's name or active status. This endpoint allows you to modify basic properties of an existing form.
## Path Parameters
| Parameter | Type | Required | Description | Example |
| --------- | ------ | -------- | ------------------ | ------------------- |
| `form_id` | string | Yes | Form ID (form\_id) | `Fecb6be7be43b4724` |
## Request Body
| Field | Type | Required | Description | Example |
| ----------- | ------- | -------- | ------------------------------------------ | -------------------------- |
| `name` | string | No | Name of the form | `"Customer Feedback Form"` |
| `is_active` | boolean | No | Whether to activate or deactivate the form | `true` or `false` |
## Examples
### Update Form Name
```bash theme={null}
curl -X PATCH "https://management.scanova.io/form/Fecb6be7be43b4724/" \
-H "Authorization: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Customer Feedback Form"
}'
```
### Activate/Deactivate Form
```bash theme={null}
curl -X PATCH "https://management.scanova.io/form/Fecb6be7be43b4724/" \
-H "Authorization: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"is_active": true
}'
```
### Update Both Name and Status
```bash theme={null}
curl -X PATCH "https://management.scanova.io/form/Fecb6be7be43b4724/" \
-H "Authorization: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Form Name",
"is_active": false
}'
```
## Response
Returns the updated form object with all current details.
## Use Cases
* **Name Management**: Update form names for better organization
* **Status Control**: Activate or deactivate forms as needed
* **Bulk Operations**: Update multiple forms programmatically
* **Workflow Management**: Control form availability based on campaigns
When you deactivate a form (`is_active: false`), it will no longer collect new submissions, but existing data remains intact. You can reactivate it later by setting `is_active: true`.
Deactivating a form will stop new submission capture immediately. Make sure to inform your team about status changes to avoid confusion.
## OpenAPI
````yaml PATCH /form/{form_id}/
openapi: 3.1.0
info:
title: Scanova Form API
description: Form management endpoints for creating, updating, and managing forms
version: 1.0.0
servers:
- url: https://management.scanova.io
description: Production server
security:
- apiKeyAuth: []
tags:
- name: Form
description: Form management operations
paths:
/form/{form_id}/:
patch:
tags:
- Form
summary: Update Form
description: Updates a form's name or active status. Requires authentication.
parameters:
- name: form_id
in: path
required: true
description: Form ID (form_id)
schema:
type: string
example: Fecb6be7be43b4724
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFormRequest'
examples:
update_name:
summary: Update form name
value:
name: Updated Form Name
activate_deactivate:
summary: Activate/Deactivate form
value:
is_active: true
responses:
'200':
description: Form updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Form'
'400':
description: Bad request - Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'401':
description: Unauthorized - Invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationErrorResponse'
'404':
description: Form not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- apiKeyAuth: []
components:
schemas:
UpdateFormRequest:
type: object
properties:
name:
type: string
description: Name of the form
example: Updated Form Name
is_active:
type: boolean
description: Whether to activate or deactivate the form
example: true
Form:
type: object
properties:
id:
type: integer
description: Internal form ID
example: 301
form_id:
type: string
description: Unique form identifier
example: Fecb6be7be43b4724
name:
type: string
description: Name of the form
example: Customer Feedback Form
created:
type: string
format: date-time
description: Creation timestamp
example: '2024-03-15T10:30:00.000000+05:30'
modified:
type: string
format: date-time
description: Last modification timestamp
example: '2024-03-15T10:30:00.000000+05:30'
is_active:
type: boolean
description: Whether the form is active
example: true
usage_count:
type: integer
description: Number of QR codes this form is linked to
example: 3
entries_count:
type: integer
description: Number of form submissions collected
example: 42
conversion:
type: number
format: float
description: Conversion rate as a percentage (entries / total scans * 100)
example: 68.5
linked_qrs:
type: array
description: QR codes linked to this form
items:
type: object
properties:
qr_code__id:
type: integer
example: 150157
qr_code__qrid:
type: string
example: Qff07909fe1c14923
qr_code__name:
type: string
example: Event Booth QR
qr_code__qr_type:
type: string
example: dy
data:
type: string
description: JSON string containing the form configuration
example: >-
[{"type":"page_layout","data":{"themeId":"ocean-clean"}},{"type":"design_info","data":{"color":{"background":"#C1E8FA"},"button":{"color":"#2D2B2B","textColor":"#FFFFFF","cornerRadius":2,"fontFamily":"Inter","showDropShadow":false},"text":{"headerTitle":{"color":"#2D2B2B","fontFamily":"Inter","fontSize":1},"body":{"color":"#2D2B2B","fontFamily":"Inter","fontSize":1},"privacy":{"color":"#2D2B2B","fontFamily":"Inter","fontSize":1}}}},{"type":"form_details","data":{"title":"Get
in Touch with Us","description":"Interested in our services? Fill
out the form and we'll get back to
you.","questions":[{"question":"Full
Name","answer":{"type":"shortAnswer"},"isRequired":true}]}},{"type":"submit_button","data":{"label":"Submit"}},{"type":"skip_button","data":{"label":"Skip"}}]
ValidationErrorResponse:
type: object
properties:
field_name:
type: array
items:
type: string
description: Field-specific validation errors
example:
- This field is required.
- Invalid value provided.
additionalProperties:
type: array
items:
type: string
description: Additional field validation errors
AuthenticationErrorResponse:
type: object
properties:
detail:
type: string
description: Authentication error message
example: Invalid token.
ErrorResponse:
type: object
properties:
detail:
type: string
description: Error message
example: Not found.
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: Authorization
description: >-
API key authentication. Enter your API key directly in the Authorization
header.
````