Activities / Entity
Create Activity
This endpoint allows you to create an Activity based on JSON input.
You will only be able to create an Activity after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST BODY
| Attribute | Type | Description |
|---|---|---|
| accountId (Required) | Integer | ID of the Account to which the Activity is linked to (see Accounts resource) |
| contactId | Integer | Contact the Activity is linked to (see Contacts resource) |
| opportunityId | Integer | Opportunity to which the Activity is linked to (see Opportunities resource) |
| typeId (Required) | Integer | Activity Type ID (see Types resource) |
| salesRepId (Required) | Integer | Unique identifier of the User associated to the Activity (see Users resource) |
| checkin | Boolean | True in the case the Activity had been certified to done within the geofencing range, false otherwise |
| checkinTypeId | Integer | It exists three different types of checkin: 1 (check-in at an Account's location); 2 (check-in at an open Opportunity); 3 (fast check-in when a User reports a physical visit without having to link them to any existing Account or Opportunity in ForceManager) |
| checkoutDate | String | Date and time for the check-out. Registers the end of a visit to a client |
| comment | String | A comment of the Activity |
| date (Required) | String | Date referred to the moment in which the Activity took place |
| geocoded | Boolean | If true, the Activity has been geolocated and a geocode is automatically calculated by the system (latitude and longitude) |
| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |
| latitude | Number | Geocode address for the latitude coordinates |
| longitude | Number | Geocode address for the longitude coordinates |
| permissionLevel | String | Defines the visibility of the Activity. Set from 1 to 5 being 5 the highest level of permission |
| readOnly | Boolean | If true, the Activity cannot be modified or deleted |
| extId | String | External ID of the Activity from a third party system (ERP, CRM, Accounting System) |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| id | Integer | Id assigned to the new Activity |
| Message | String | Shows the operation status |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
post/activities
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/activities
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Create Activity
Changes
No recorded changes to this operation across all 1 revision of this API.