POST
/v1/comms/messages/{id}/cancelCancel a queued message
Withdraws a message that has not gone out yet. Only while it is still queued — once a sender holds it we cannot know whether it has already left, and that comes back as a not-found rather than a cheerful yes.
Access class: workspace.
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.
Parameters
Values are applied to the request and the example on the right.
idpath · stringrequired
Request body
application/jsonrequiredbodyobjectoptional
paramsoptional
queryobjectoptional
Responses
201application/json
the action's answer
{
"status": "string"
}statusstringoptional
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