Create TimeTrackSettings
POST {{baseUrl}}/api/v1/timeTrackSettings
This API adds a TimeTracking configuration to your helpdesk.
OAuth Scope
Desk.settings.CREATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| isTimeTracking (required) | <boolean> | Time tracking refers to the process of recording the time agents take to resolve tickets. This information can be recorded manually or automatically, based on your organization's requirement and preference. APIs related to this endpoint help you configure the settings for automated time tracking. |
| depId (required) | <long> | ID of the department in which time tracking must be enabled or disabled. |
| isBillable | <boolean> | Key that returns if the time tracked is billable or not. |
| billingType | <String> | Type of billing configured. Values supported are FIXED_COST_FOR_TICKETS FIXED_COST_FOR_AGENTS SPECIFIC_COST_PER_AGENT and SPECIFIC_COST_PER_PROFILE |
| fixedCost | <Double> | Cost fixed for either billing category - by ticket or by agent. |
| agents | <list> | List of agents in the department |
| profiles | <list> | List of user profiles defined in the department |
| timerAction | <String> | Action that the active timers in the department must perform. Values supported are ADD and DISCARD |
| activityPreference | <list> | Activity preference(s) |
| ticketPreference | <list> | Ticket preference(s) |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"ticketPreference":{"autoTrackAction":{"fieldUpdate":true,"onChatComplete":true,"onRemoteAssist":true,"commentActions":true,"approvalActions":true,"sendReply":true,"manualDraft":true,"resolutionActions":true,"attachmentActions":true},"isReviewTime":false,"isAutoPause":true,"isAutoTimer":true,"isHideTimeTracking":false},"billingType":"SPECIFIC_COST_PER_AGENT","activityPreference":{"isTasksEnabled":true,"trackMode":"CONSECUTIVE","isEventsEnabled":true,"canAutoTrackCalls":true},"fixedCost":"1000","profiles":[{"cost":"100","id":"1"},{"cost":"200","id":"2"}],"depId":"1892000000006907","isTimeTracking":true,"isBillable":true,"agents":[{"cost":"100","id":"1"},{"cost":"200","id":"2"}]}