Skip to main content
PATCH
/
lead
/
{lead_list_id}
curl --request PATCH \
  --url https://management.scanova.io/lead/{lead_list_id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Marketing Lead List"
}
'
{
  "id": 262,
  "lead_id": "Lecb6be7be43b4724",
  "name": "Onit Lead",
  "created": "2023-08-04T13:51:51.959871+05:30",
  "modified": "2023-08-04T13:51:51.959871+05:30",
  "is_active": true,
  "usage_count": 5,
  "entries_count": 7,
  "linked_qrs": [
    {
      "qr_code__id": 150157,
      "qr_code__qrid": "Qff07909fe1c14923",
      "qr_code__name": "Androd",
      "qr_code__qr_type": "dy"
    }
  ],
  "data": "[{\"type\":\"page_title\",\"data\":{\"title\":\"<p>TEST FOR NEW LEAD NOPW</p>\\n\",\"cardStyle\":{\"backgroundColor\":\"#F8F8F8\"}}},{\"type\":\"page_layout\",\"data\":{\"backgroundColor\":\"0a2e9b\"}},{\"type\":\"description_box\",\"data\":{\"text\":\"<p>NEW LEAD NEW</p>\\n\",\"cardStyle\":{\"backgroundColor\":\"#F8F8F8\"}}},{\"type\":\"banner_images\",\"data\":{\"images\":[{\"url\":\"https://qcg7-storage-staging.s3.amazonaws.com/media/uploads/560/2023/06/20230620_462316_qrcode.png\"}]}},{\"type\":\"lead_form\",\"data\":{\"description\":\"Food Preference\",\"questions\":[{\"question\":\"FOOD PREFERENCES\",\"answer\":{\"type\":\"multipleChoice\",\"data\":[{\"option\":\"VEG\"},{\"option\":\"NON VEG\"}]},\"isRequired\":true}]}},{\"type\":\"submit_button\",\"data\":{\"label\":\"SUBMIT\",\"color\":{\"label\":\"#585858\",\"button\":\"#F8F8F8\",\"border\":\"#F8F8F8\"},\"buttonStyle\":{\"borderWidth\":1,\"borderRadius\":50}}},{\"type\":\"skip_button\",\"data\":{\"label\":\"SKIP\",\"color\":{\"label\":\"#585858\",\"button\":\"#F8F8F8\",\"border\":\"#F8F8F8\"},\"buttonStyle\":{\"borderWidth\":1,\"borderRadius\":50}}}]",
  "webhooks": [
    {
      "id": 16,
      "url": "https://webhook.site/8e85fafd-a4d0-433b-bf80-5bb11eed4ea6",
      "created": "2023-06-20T16:24:00.060154+05:30",
      "modified": "2023-06-20T16:24:03.157414+05:30"
    }
  ]
}

​
Overview

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

​
Path Parameters

ParameterTypeRequiredDescriptionExample
lead_list_idstringYesLead list ID (lead_id)Lecb6be7be43b4724

​
Request Body

FieldTypeRequiredDescriptionExample
namestringNoName of the lead list"Marketing Lead List"
is_activebooleanNoWhether to activate or deactivate the lead listtrue or false

​
Examples

​
Update Lead List Name

curl -X PATCH "https://management.scanova.io/lead/Lecb6be7be43b4724/" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Marketing Lead List"
  }'

​
Activate/Deactivate Lead List

curl -X PATCH "https://management.scanova.io/lead/Lecb6be7be43b4724/" \
  -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/lead/Lecb6be7be43b4724/" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Lead List Name",
    "is_active": false
  }'

​
Response

Returns the updated lead list object with all current details.

​
Use Cases

  • Name Management: Update lead list names for better organization
  • Status Control: Activate or deactivate lead lists as needed
  • Bulk Operations: Update multiple lead lists programmatically
  • Workflow Management: Control lead list availability based on campaigns
When you deactivate a lead list (is_active: false), it will no longer capture new leads, but existing data remains intact. You can reactivate it later by setting is_active: true.
Deactivating a lead list will stop new lead 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

​
lead_list_id
string
required

Lead list ID (lead_id)

Body

application/json
​
name
string

Name of the lead list

Example:

"Marketing Lead List"

​
is_active
boolean

Whether to activate or deactivate the lead list

Example:

true

Response

Lead list updated successfully

​
id
integer

Internal lead list ID

Example:

262

​
lead_id
string

Unique lead list identifier

Example:

"Lecb6be7be43b4724"

​
name
string

Name of the lead list

Example:

"Onit Lead"

​
created
string<date-time>

Creation timestamp

Example:

"2023-08-04T13:51:51.959871+05:30"

​
modified
string<date-time>

Last modification timestamp

Example:

"2023-08-04T13:51:51.959871+05:30"

​
is_active
boolean

Whether the lead list is active

Example:

true

​
usage_count
integer

Number of times this lead list has been used

Example:

5

​
entries_count
integer

Number of lead entries in this list

Example:

7

​
linked_qrs
object[]

QR codes linked to this lead list

​
data
string

JSON string containing lead list form configuration

Example:

"[{\"type\":\"page_title\",\"data\":{\"title\":\"<p>TEST FOR NEW LEAD NOPW</p>\\n\",\"cardStyle\":{\"backgroundColor\":\"#F8F8F8\"}}},{\"type\":\"page_layout\",\"data\":{\"backgroundColor\":\"0a2e9b\"}},{\"type\":\"description_box\",\"data\":{\"text\":\"<p>NEW LEAD NEW</p>\\n\",\"cardStyle\":{\"backgroundColor\":\"#F8F8F8\"}}},{\"type\":\"banner_images\",\"data\":{\"images\":[{\"url\":\"https://qcg7-storage-staging.s3.amazonaws.com/media/uploads/560/2023/06/20230620_462316_qrcode.png\"}]}},{\"type\":\"lead_form\",\"data\":{\"description\":\"Food Preference\",\"questions\":[{\"question\":\"FOOD PREFERENCES\",\"answer\":{\"type\":\"multipleChoice\",\"data\":[{\"option\":\"VEG\"},{\"option\":\"NON VEG\"}]},\"isRequired\":true}]}},{\"type\":\"submit_button\",\"data\":{\"label\":\"SUBMIT\",\"color\":{\"label\":\"#585858\",\"button\":\"#F8F8F8\",\"border\":\"#F8F8F8\"},\"buttonStyle\":{\"borderWidth\":1,\"borderRadius\":50}}},{\"type\":\"skip_button\",\"data\":{\"label\":\"SKIP\",\"color\":{\"label\":\"#585858\",\"button\":\"#F8F8F8\",\"border\":\"#F8F8F8\"},\"buttonStyle\":{\"borderWidth\":1,\"borderRadius\":50}}}]"

​
webhooks
object[]

Webhooks configured for this lead list