Remove Values from a Dependent Drop-down Lead Field
Lets you remove values from a dependent (child) drop-down lead field.
- Specify the schema name of the parent field in the “ParentSchemaName” parameter.
- Use the “ParentFieldValue” parameter to specify the parent field value for which you want to remove values from the child field.
- Specify the schema name of the dependent drop-down field you want to update in the “ChildSchemaName” parameter.
- Use the “Options” parameter to remove one or more values to the dependent drop-down field.
For information on adding options to a dependent fields, see Add Values to a Dependent Drop-down Lead Field.
API URL
URL
POST
https://{host}/v2/LeadManagement.svc/LeadField/Dependency/Dropdown/Options/Remove?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"ParentSchemaName": "mx_Country",
"ChildSchemaName": "mx_State",
"ParentFieldValue": "India",
"Options": [
"AP",
"TS"
]
}
Request Parameters
| Parameter | Description |
|---|---|
| ParentSchemaName | Schema name of the parent drop down field. You can find it in the LeadSquared application by navigating to My Profile>Settings>Customization>Lead Fields. |
| ChildSchemaName | Schema name of the child/dependent drop-down field. You can find it in the LeadSquared application by navigating to My Profile>Settings>Customization>Lead Fields. |
| ParentFieldValue | The parent field value against which you want to remove values from the child field. |
| Options | List of values you want to remove from the child drop-down field. |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"AffectedRows": 2
}
}
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. |
