Post an Activity on an Account
Lets you post an activity on a particular account.
Note:
- You must create activity types first. Navigate to My Profile>Settings>Accounts Customization>Custom Activities and Scores.
- The activity type you create must be enabled for the particular account type where you want to post it. For more information, see How to Post Activities on Accounts.
API URL
URL
POST
https://{host}/v2/CompanyActivity.svc/Create?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"RelatedCompanyId": "8933fa5e-5b39-11e9-826a-0622360da6fe",
"ActivityEvent": 10001,
"ActivityNote": "Activity Notes",
"Fields": [
{
"SchemaName": "Status",
"Value": "Active"
},
{
"SchemaName": "Owner",
"Value": "643f6525-3e7a-11e6-b61b-22000aa8e760"
},
{
"SchemaName": "mx_Custom_1",
"Value": "String"
}
]
}
Request Parameters
| Parameter | Description |
|---|---|
| RelatedCompanyId | Unique identifier of the account on which you want to post an activity. You can use the Get an Account API to retrieve this. |
| Activity Event | Unique identifier of the activity type you want to post. You can find this on the UI by navigating to My Profile>Settings>Accounts Customization>Custom Activities and Scores.
|
| ActivityNote | You can pass any notes (string) related to the activity. |
| Fields | “SchemaName” – This is the schema name of the activity field. It is available on the UI at My Profile>Settings>Accounts Customization>Custom Activities and Scores, create or edit an activity and navigate to step 2 –
“Value” – Pass the value of the activity field here. |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {"Id": "255539a4-0380-4b8c-84db-7746b46c3fe2"}
}
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. |
