PUT
/v1/workspace/heartbeatReplace workspace heartbeat
Save the heartbeat's settings. The stored bag is the starting point, so a field left out is left alone rather than reset to a zero value. A combination the rules refuse — a default snooze beyond the deferral ceiling, say — is a 400 carrying the sentence. ADMIN ONLY, while reading is any seat's.
Access class: workspace:admin.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Request body
application/jsonrequiredallow_system_eventsbooleanoptional
allowed_actionsarray<string>optional
auto_execute_on_accept_actionsarray<string>optional
enabledbooleanoptional
follow_upoptional
lifecycleoptional
max_actions_per_runintegeroptional
min_wake_interval_secondsintegeroptional
modelstringoptional
preprocess_merchant_inbound_attachmentsbooleanoptional
reasoning_effortstringoptional
wake_eventsarray<string>optional
Responses
200application/json
the action's answer
{
"data": {
"allow_system_events": true,
"allowed_actions": [
"string"
],
"auto_execute_on_accept_actions": [
"string"
],
"enabled": true,
"follow_up": {
"after_hours": 1.5,
"auto_send": true,
"enabled": true,
"max_follow_ups": 1.5,
"per_rep": true,
"reply_drafts": true,
"reps": [
"string"
],
"require_record": true,
"skip_boards": [
"string"
],
"skip_statuses": [
"string"
],
"skip_unassigned": true
},
"lifecycle": {
"default_defer_days": 1.5,
"max_defer_days": 1.5,
"revert_window_minutes": 1.5
},
"max_actions_per_run": 1.5,
"min_wake_interval_seconds": 1.5,
"model": "string",
"preprocess_merchant_inbound_attachments": true,
"reasoning_effort": "string",
"wake_events": [
"string"
]
}
}datarequired
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired