The following macros are not currently supported in the header:
- style
Create Timer
UNDER DEVELOPMENT
Service Application Warning
Timer endpoints all operate from the current user and because of this are not available to service applications. If this restriction impacts your business model, please contact support and we will consider opening certain timer access up to service applications by requiring a staff id.
The following endpoint can be used to creates and starts a new timer.
POST /timers
Parameters
Table of allowed parameters. Required fields are underlined.
subject | String | Textual description assigned to the timer as a "subject" |
---|---|---|
against_id | Integer | The id of the object the timer exists against. This must point to a valid object. |
against_type | String | The type of object the timer exists against. This must point to a valid object. |
seconds | Integer | Time in seconds appended to the currently recorded time. Defaults to zero. |
auto_start | Binary | 1 = The timer will automatically start on creation. This will pause any existing timers. 0 = The timer will be paused upon creation and existing timers will continue to run. Default to 0. |
Handling the response
Please see the get timer for controlling the response.