Get Sales Activity Settings
Returns the settings configured for a sales activity. Use this API –
- To get details of a sales activity like name, display name, currency, etc.
- To get custom field schema names (ranging from mx_Custom_1 to mx_Custom_15)
These settings are configurable under My Account>Settings>Customization>Sales Activity Settings.
API URL
URL
GET
https://{host}/v2/SalesActivity.svc/RetrieveSetting?accessKey=AccessKey&secretKey=SecretKey
Response
200 OK
Content-Type: application/json
{
"ID": "",
"Name": "Sales Activity - New",
"DisplayName": "Sales Activity",
"DefaultCurrencySymbol": "$",
"DefaultCurrencyAbbreviation": "USD",
"DefaultCurrencyName": "US Dollars",
"CustomerStageName": "Customer",
"ConvertToCustomer": true,
"Fields": [
{
"SchemaName": "mx_Custom_1",
"DisplayName": "Product",
"Value": null,
"DataType": "Product",
"IsMandatory": true,
"ShowInForm": true,
"Sequence": 1
},
{
"SchemaName": "mx_Custom_2",
"DisplayName": "Order Value",
"Value": null,
"DataType": "Number",
"IsMandatory": true,
"ShowInForm": true,
"Sequence": 2
},
{
"SchemaName": "mx_Custom_3",
"DisplayName": "Sales Date",
"Value": null,
"DataType": "DateTime",
"IsMandatory": true,
"ShowInForm": true,
"Sequence": 3
},
{
"SchemaName": "mx_Custom_4",
"DisplayName": "Sales Owner",
"Value": null,
"DataType": "ActiveUsers",
"IsMandatory": true,
"ShowInForm": true,
"Sequence": 4
},
{
"SchemaName": "mx_Custom_5",
"DisplayName": "Product Version",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": true,
"Sequence": 5
},
{
"SchemaName": "mx_Custom_6",
"DisplayName": "Custom 2",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 6
},
{
"SchemaName": "mx_Custom_7",
"DisplayName": "Custom 3",
"Value": null,
"DataType": "Number",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 7
},
{
"SchemaName": "mx_Custom_8",
"DisplayName": "Custom 4",
"Value": null,
"DataType": "Number",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 8
}
]
}
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. |
