Update Activity Type
This API helps in updating name, score, description, custom fields and other properties of a given custom activity type. Each custom activity has a unique id. That Id can be obtained by using Get List of Activity Types API.
Pass that Id in the request body and the updated activity type property data.
API URL
URL
POST
https://{host}/v2/ProspectActivity.svc/CustomActivityType/Update?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"ID": "5f47d58f-5d17-11e6-9887-22000aa582a3",
"ActivityEventName": "Updated Activity Name",
"Score": 15,
"Description": "Updated Description",
"EventDirection": 1,
"CanDeleteActivity": true,
"Fields": [
{
"SchemaName": "mx_Custom_2",
"DisplayName": "New display name of Custom 2",
"Value": null,
"DataType": "Number",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 2,
"OptionSet": ""
}
]
}
Request Parameters
| Parameter | Description |
|---|
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. |
