Skip to main content
PATCH
/
form
/
{form_id}
curl --request PATCH \
  --url https://management.scanova.io/form/{form_id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Form Name"
}
'
{
  "id": 301,
  "form_id": "Fecb6be7be43b4724",
  "name": "Customer Feedback Form",
  "created": "2024-03-15T10:30:00.000000+05:30",
  "modified": "2024-03-15T10:30:00.000000+05:30",
  "is_active": true,
  "usage_count": 3,
  "entries_count": 42,
  "conversion": 68.5,
  "linked_qrs": [
    {
      "qr_code__id": 150157,
      "qr_code__qrid": "Qff07909fe1c14923",
      "qr_code__name": "Event Booth QR",
      "qr_code__qr_type": "dy"
    }
  ],
  "data": "[{\"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\"}}]"
}

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.

​
Overview

Updates a form’s name or active status. This endpoint allows you to modify basic properties of an existing form.

​
Path Parameters

ParameterTypeRequiredDescriptionExample
form_idstringYesForm ID (form_id)Fecb6be7be43b4724

​
Request Body

FieldTypeRequiredDescriptionExample
namestringNoName of the form"Customer Feedback Form"
is_activebooleanNoWhether to activate or deactivate the formtrue or false

​
Examples

​
Update Form Name

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

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

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.

Authorizations

​
Authorization
string
header
required

API key authentication. Enter your API key directly in the Authorization header.

Path Parameters

​
form_id
string
required

Form ID (form_id)

Body

application/json
​
name
string

Name of the form

Example:

"Updated Form Name"

​
is_active
boolean

Whether to activate or deactivate the form

Example:

true

Response

Form updated successfully

​
id
integer

Internal form ID

Example:

301

​
form_id
string

Unique form identifier

Example:

"Fecb6be7be43b4724"

​
name
string

Name of the form

Example:

"Customer Feedback Form"

​
created
string<date-time>

Creation timestamp

Example:

"2024-03-15T10:30:00.000000+05:30"

​
modified
string<date-time>

Last modification timestamp

Example:

"2024-03-15T10:30:00.000000+05:30"

​
is_active
boolean

Whether the form is active

Example:

true

​
usage_count
integer

Number of QR codes this form is linked to

Example:

3

​
entries_count
integer

Number of form submissions collected

Example:

42

​
conversion
number<float>

Conversion rate as a percentage (entries / total scans * 100)

Example:

68.5

​
linked_qrs
object[]

QR codes linked to this form

​
data
string

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\"}}]"