Remove Values from a Dependent Drop-down Activity Field
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Removes one or more values from a dependent (child) drop-down activity field.
- In the query string, specify –
- “code” – Code of the custom activity. You can find them on the Custom Activities & Scores page, under the ‘Code’ column. Alternatively, you can call the Get List of Activity Types API.
- “fieldName” – The schema name of the dependent drop-down custom activity field. You can retrieve this by calling the Get Activity Details API.
- In the JSON body, specify
- “Parent” – The option in the parent field.
- “Option” – The options you want to remove under the parent option.
API URL
URL
POST
https://{host}/v2/ProspectActivity.svc/CustomActivity/DependentFieldOptions/Pop?accessKey=AccessKey&secretKey=SecretKey&code=code&fieldName=fieldName
URL Parameters
| Parameter | Description |
|---|---|
| code | The activity event code. |
| fieldName | Schema name of the activity field. |
Request
Content-Type: application/jsonJSON Body/Payload
[
{
"Parent":"Science",
"Options":[
"M.Sc Physics",
"M.Sc Virology"
]
}
]
Request Parameters
| Parameter | Description |
|---|---|
| Parent | Name of the parent field. |
| Options | The dependent field options you want to remove. |
Response
200 OK
Content-Type: application/json
{
"Status":"Success"
}
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. |
