Calls off an open batch.
The items go back to READY at the stage that asked, so a later pass re-batches them — cancelling the question is not the same as deciding the items no longer need one. The response's `returnedCount` is how many went back; its `waitingCount` is read after the cancel and is 0. Returns 409 when the batch has already been answered or expired.
Authorization
Bearer JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.
In: header
Path Parameters
The trigger identifier.
uuidThe batch identifier.
uuidThe tenant identifier
Optional reason.
Why the question is being called off. Optional — unlike ignoring an item, cancelling a batch is reversible by construction: the items go back to the asking stage and a later pass re-batches them, so nothing is decided that a reason would have to justify.
length <= 4000Response Body
curl -X POST "https://api.fruxon.com/v1/tenants/string/triggers/497f6eca-6276-4993-bfeb-53cbbbba6f08/ledger/batches/497f6eca-6276-4993-bfeb-53cbbbba6f08:cancel" \ -H "Content-Type: application/json" \ -d '{}'{
"returnedCount": 0,
"id": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"stageId": "string",
"status": "OPEN",
"deliveryMode": "DIRECT",
"waitingCount": 0,
"draftCount": 0,
"artifact": null,
"topicId": "00000000-0000-0000-0000-000000000000",
"conversationState": "ACTIVE",
"conversationResolution": "GOAL_MET",
"conversationEndedAt": 0,
"conversationEndedUnanswered": false,
"conversationParticipantName": "string",
"question": "string",
"delivery": "DELIVERED",
"deliveryDetail": "string",
"slotName": "string",
"expiresAt": 0,
"gatheringUntil": 0,
"lastJoinedAt": 0,
"resolvedAt": 0,
"createdAt": 0,
"detail": "string"
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}Reads what one batch question was answered with, item by item.
One row per item the batch held: the value it was handed back (`answer`) beside what the person gave for it (`given`) — the sheet cell or the words in their message, as the agent conducting the conversation copied them; a direct question's reply; a form's field — and where the item is now. The two differ exactly where an answer went wrong, which is the question this read exists for. `topicAgentId` is the agent the batch's conversation belongs to — the stage's asking agent, not the one that talked to the person (`conductorAgentId`) — and is the agent to read its transcript under. A batch answered before answers were recorded has `recorded` false: its values are read back off its conversation's result, with no per-item time.
Lists the automation's batch runs — one agent run over a group of items each.
At a stage that processes in batches, the sweep gathers items into groups and hands each closing group to one run. Each entry is one such run: the group it took, how many members, where it stands, and — once it reported back — what it cost and how long it took. Newest first.