Activities / Points
Update Activity Points
This endpoint allows you to update one or more Activity Points.
You will only be able to update an Activity Point 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
This endpoint allows updating the information of an Activity Point. In order to update a Point, you just have to specify the attributes you want to modify and complete with the up to date information. It is not necessary to send all attributes.
| Attribute | Type | Description |
|---|---|---|
| IntervalDays | Integer | Days before today that will be used to calculate the Scores |
| PointsPerActivity | Integer | Points that the user will receive when performing an Activity that is not of "Visit" Type |
| PointsPerCheckin | Integer | Points that the user will receive when performing a "Checkin" |
| PointsPerEmail | Integer | Points that the user will receive for each received/sent "Email" |
| PointsPerInternalEmail | Integer | Points the user will receive for each "Email" they receive/send internal |
| PointsPerInternalPhoneCallMinute | Integer | Points the user will receive depending on the duration of their internal "Calls" |
| PointsPerOpportunity | Integer | Points the user will receive for each Opportunity won |
| PointsPerPhoneCallMinute | Integer | Points the user will receive depending on the duration of their "Calls" |
| PointsPerSalesOrder | Integer | Points that the user will receive for each Order won |
| PointsPerVisit | Integer | Points that the user will receive when performing an Activity of "Visit" Type |
| SalesInput | Integer | The sales will be calculated: 0 -> with customized Z_viewsalesuser. If 1 -> With won Opportunities. If 2 -> With won Quotes. If 3 -> With won sales Orders |
| ScoringPerEnvironment | Integer | 0 -> the scores will be relative to the all implementation. If different than 0 the scores will be relative to the Branch |
RESPONSE
Returns a JSON with information about the Activity Point just updated.
| Attribute | Description |
|---|---|
| Message | 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 |
put/activity/points
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/activity/points
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Update Activity Points
Changes
No recorded changes to this operation across all 1 revision of this API.