Calls
Update Call
This endpoint allows you to update specific information of a Call. If the specified Call does not exist, the response will be a "bad request".
You will only be able to update a Call 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 a specific Call. In order to update a Call, 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 |
|---|---|---|
| duration | Integer | Duration of the Call, in seconds |
| startDate | String | Moment in which the Call is started |
| endDate | String | Moment in which the Call is ended |
| type | Integer | 0 if it is an incoming Call, 1 if it is an outgoing call, 2 if it is a missed call |
| terminalType | Integer | Set to 1, it is a free field to eventually distinguish the type of terminals |
| phone | String | The called phone number |
| accountId | Integer | Account to which the Call is linked to (see Accounts resource) |
| contactId | Integer | Contact to which the Call is linked to (see Contacts resource) |
| salesRepId | Integer | Unique identifier of the User associated to the Call (see Users resource) |
| opportunityId | Integer | Opportunity to which the Call is linked to (see Opportunities resource) |
| phoneAlias | String | An alias of the phone number, e.g. a Contact name |
| description | String | A descriptive text of the Call content |
| timeZoneId | Integer | TimeZone of the Call (see TimeZones resource) |
RESPONSE
Returns a JSON with information about the Call just updated.
| Attribute | Type | Description |
|---|---|---|
| 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 |
put/calls/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/calls/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Update Call
Changes
No recorded changes to this operation across all 1 revision of this API.