Built-in tool
Cancel a waiting action
Drop an approval or connection card still waiting in this chat, when the person asks to cancel it.
Freeno per-call chargeNo API key needed
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| pendingActionIdstring · optional | string | optional | The waiting card to drop, when more than one is waiting in this chat. Omit it when there is only one. |
| allboolean · optional | boolean | optional | Drop every card waiting in this chat. |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"success",
"cancelled",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "Why nothing was dropped, when the call was refused before reading or changing a card."
},
"message": {
"type": "string",
"description": "What happened, to tell the person."
},
"success": {
"type": "boolean",
"description": "Whether every requested card was dropped."
},
"waiting": {
"type": "array",
"items": {
"type": "object",
"required": [
"pendingActionId",
"kind",
"name"
],
"properties": {
"kind": {
"enum": [
"approval",
"integration"
],
"type": "string"
},
"name": {
"type": "string"
},
"pendingActionId": {
"type": "string"
}
},
"additionalProperties": false
},
"description": "When more than one card is waiting and none was named: the cards to choose from."
},
"cancelled": {
"type": "array",
"items": {
"type": "object",
"required": [
"pendingActionId",
"kind",
"name"
],
"properties": {
"kind": {
"enum": [
"approval",
"integration"
],
"type": "string"
},
"name": {
"type": "string",
"description": "What the card was for."
},
"pendingActionId": {
"type": "string"
}
},
"additionalProperties": false
},
"description": "The cards dropped. Nothing they would have done has run, and nothing was charged for them."
}
},
"additionalProperties": false
}
