Remove Values from a Lead Drop-down Field
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
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.
- For e.g., pass
- The values you want to remove in the “Options” parameter
API URL
URL
POST
https://{host}/v2/LeadManagement.svc/LeadField/Dropdown/Options/Remove?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonUpdate Lead Field
Update CFS Field
{
"SchemaName": "mx_Custom1",
"Options": ["value1","value2"]
}
{
"SchemaName":"mx_Docs~mx_CustomObject_5",
"Options":[
"Approved",
"Pending",
"Cancelled",
"Rejected",
"Verification Pending",
"Verification Cancelled",
"ApplicationApproved",
"Application On Hold",
"Verification Successful",
"Verification On Hold",
"Dropped"
]
}
Request Parameters
| Parameter | Description |
|---|---|
| SchemaName | 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 –
|
| Options | List the values you wish to remove from the drop-down field specified. |
Response
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. |
