LeadSquared Developer Centre


Remove Values from a Lead Drop-down Field

Lets you remove values from a lead field of drop-down type. In the JSON body, pass –

  • The “Schema Name” of the drop-down field you want to remove values from
  • The values you want to remove in the “Options” parameter


To remove values from a dropdown type CFS field associated with leads, in the JSON body, pass –

  • The “SchemaName” of the lead field and the dropdown type CFS field, separated by the “~” symbol.
    • For e.g., pass "SchemaName": “mx_Custom_1~mx_CustomObject_3”, where “mx_Custom_1” is the schema name of the Lead Field, and “mx_CustomObject_3” is the schema name of the dropdown type CFS field.
  • The values you want to remove in the “Options” parameter


POST https://{host}/v2/LeadManagement.svc/LeadField/Dropdown/Options/Remove?accessKey=AccessKey&secretKey=SecretKey


Content-Type: application/json
Update Lead Field Icon
Update CFS Field Icon
		"SchemaName": "mx_Custom1",
		"Options": ["value1","value2"]
      "Verification Pending",
      "Verification Cancelled",
      "Application On Hold",
      "Verification Successful",
      "Verification On Hold",

Request Parameters

Parameter Description

To update the lead field

Pass the schema name of the drop-down field. You can find these by navigating to My Profile>Settings>Leads>Lead Fields


To update the CFS field



List the values you wish to remove from the drop-down field specified.


200 OK
Content-Type: application/json
    "Status": "Success",
    "Message": {
        "AffectedRows": 1

HTTP Response Codes

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.

On this page

© 2024 by MarketXpander Services Pvt Ltd. All Rights Reserved.