FruxonDocs
Agent NetworkTriggers

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. Returns 409 when the batch has already been answered or expired.

POST
/v1/tenants/{tenant}/triggers/{trigger}/ledger/batches/{batch}:cancel
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

trigger*string

The trigger identifier.

Formatuuid
batch*string

The batch identifier.

Formatuuid
tenant*string

The tenant identifier

Optional reason.

reason?string|null

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.

Lengthlength <= 4000
[key: string]?never

Response 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 '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "stageId": "string",
  "status": "OPEN",
  "waitingCount": 0,
  "artifact": null,
  "topicId": "00000000-0000-0000-0000-000000000000",
  "expiresAt": 0,
  "gatheringUntil": 0,
  "lastJoinedAt": 0,
  "resolvedAt": 0,
  "createdAt": 0,
  "detail": "string"
}
Empty
Empty
{
  "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
}