Add Values to a Lead Drop-down Field

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

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

 

API URL

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

Request

JSON Body/Payload

Content-Type: application/json

{
		"SchemaName": "mx_Custom1",
		"Options": ["value1","value2"]
}

JSON Properties

Parameter Description
SchemaName

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

Options

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

Response

200 OK

Content-Type: application/json

{
    "Status": "Success",
    "Message": {
        "AffectedRows": 1
    }
}

HTTP Response Code

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.