Add Values to a Custom Activity Drop-down Field

Allows you to add values to a drop-down custom field of a specific activity type.

  1. In the API URL, pass the ‘eventCode’ to specify the activity type and the ‘fieldName’ (you must pass the schema name here) to specify the custom drop-down field you want to add values to.
  2. In the JSON body, pass the values you want to add to the custom field.

You can find the ‘eventCode’ by navigating to My Account>Settings>Customizations>Activities and Scores>Cutom Activities & Scores. If you click on the pencil icon and edit the activity you’ll also find the schema names of all activity fields.

API URL

POST
https://{host}/v2/ProspectActivity.svc/CustomActivity/FieldOptions/Push?accessKey=AccessKey&secretKey=SecretKey&code=EventCode&fieldName=FieldName
Copy URL

URL Parameters

Parameter Description
EventCode The activity event code.
FieldName The name of the drop-down field you want to add options to.

Request

JSON Body/Payload

Content-Type: application/json

[
    "Open", 
    "Close", 
    "Invalid"
]

JSON Properties

Parameter Description

Response

200 OK

Content-Type: application/json

{
    "Status": "Success"
}

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.