Get a Sales Activity by Id
Returns the details of a sales activity corresponding to the sales activity Id you provide in the JSON body.
To retrieve a sales activity using the lead Id, refer to Retrieve Sales Activities by Lead Id.
API URL
URL Parameters
Parameter | Description |
---|---|
ActivityId | Unique Id of the sales activity. |
Response
{ "ID": "ea582d40-6cd1-11e5-a199-22000aa4133b", "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": "3439951a-0e8c-11e5-981b-22000a9700b4", "DataType": "Product", "IsMandatory": true, "ShowInForm": true, "Sequence": 1, "OptionSet": "" }, { "SchemaName": "ProductName", "DisplayName": null, "Value": "123 - 123", "DataType": null, "IsMandatory": false, "ShowInForm": false, "Sequence": 0, "OptionSet": null, "IsDerived": true }, { "SchemaName": "mx_Custom_2", "DisplayName": "Order Value", "Value": "3.00", "DataType": "Number", "IsMandatory": true, "ShowInForm": true, "Sequence": 2, "OptionSet": "" }, { "SchemaName": "mx_Custom_3", "DisplayName": "Sales Date", "Value": "2015-10-07 09:00:37", "DataType": "DateTime", "IsMandatory": true, "ShowInForm": true, "Sequence": 3, "OptionSet": "" }, { "SchemaName": "mx_Custom_4", "DisplayName": "Sales Owner", "Value": "6ba64831-b1c1-11e4-981b-22000a9700b4", "DataType": "ActiveUsers", "IsMandatory": true, "ShowInForm": true, "Sequence": 4, "OptionSet": "" }, { "SchemaName": "SalesOwner", "DisplayName": null, "Value": "rizwan ali", "DataType": null, "IsMandatory": false, "ShowInForm": false, "Sequence": 0, "OptionSet": null, "IsDerived": true }, { "SchemaName": "mx_Custom_5", "DisplayName": "Quantity", "Value": "2", "DataType": "Number", "IsMandatory": false, "ShowInForm": true, "Sequence": 5, "OptionSet": "" }, { "SchemaName": "mx_Custom_6", "DisplayName": "Custom 2", "Value": "", "DataType": "String", "IsMandatory": false, "ShowInForm": false, "Sequence": 6, "OptionSet": "" }, { "SchemaName": "mx_Custom_7", "DisplayName": "Custom 3", "Value": "", "DataType": "Number", "IsMandatory": false, "ShowInForm": false, "Sequence": 7, "OptionSet": "" }, { "SchemaName": "mx_Custom_8", "DisplayName": "Custom 4", "Value": "", "DataType": "Number", "IsMandatory": false, "ShowInForm": false, "Sequence": 8, "OptionSet": "" }, { "SchemaName": "mx_Custom_9", "DisplayName": "Custom 9", "Value": "", "DataType": "String", "IsMandatory": false, "ShowInForm": false, "Sequence": 9, "OptionSet": "" }, { "SchemaName": "mx_Custom_10", "DisplayName": "Custom 10", "Value": "", "DataType": "String", "IsMandatory": false, "ShowInForm": false, "Sequence": 10, "OptionSet": "" }, { "SchemaName": "mx_Custom_11", "DisplayName": "Custom 11", "Value": "", "DataType": "String", "IsMandatory": false, "ShowInForm": false, "Sequence": 11, "OptionSet": "" }, { "SchemaName": "mx_Custom_12", "DisplayName": "Custom 12", "Value": "", "DataType": "String", "IsMandatory": false, "ShowInForm": false, "Sequence": 12, "OptionSet": "" }, { "SchemaName": "mx_Custom_13", "DisplayName": "Custom 13", "Value": "", "DataType": "String", "IsMandatory": false, "ShowInForm": false, "Sequence": 13, "OptionSet": "" }, { "SchemaName": "mx_Custom_14", "DisplayName": "Custom 14", "Value": "", "DataType": "String", "IsMandatory": false, "ShowInForm": false, "Sequence": 14, "OptionSet": "" }, { "SchemaName": "mx_Custom_15", "DisplayName": "Custom 15", "Value": "", "DataType": "String", "IsMandatory": false, "ShowInForm": false, "Sequence": 15, "OptionSet": "" } ], "CreatedBy": "6ba64831-b1c1-11e4-981b-22000a9700b4", "CreatedByName": "rizwan ali", "CreatedOn": "/Date(1444208454000+0000)/", "CancelledBy": "", "CancelledByName": "", "CancellationNotes": "" }
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. |