/v1/workspace/heartbeat/stops/{id}Stop or resume the heartbeat for a conversation
Send {"stopped": true} to make the heartbeat write nothing more for this conversation — no reply drafts, no follow-ups — and for every other conversation filed under the same record; the drafts already waiting for them are settled as refused and the count comes back as refused. {"stopped": false} resumes it. :id is the conversation id. Any seat that can read the conversation; nothing is sent either way. Use it when a person says to leave a lead, deal or merchant alone; to stop a whole status or board use the heartbeat settings instead.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"conversation_id": 1,
"refused": 1,
"stopped": true
}
}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"
}