Cancel batch

POST
/api/v1/automations/{automationId}/batches/{batchId}/cancel

Authorization

bearerAuth
headerAuthorizationBearer <token>

An API key created in Capy under Settings → API.

Path parameters

automationId*string
batchId*string

Response body

AutomationWebhookBatch

application/json
  1. response
id*string
automationId*string
triggerId*string
status*WebhookBatchStatus

Collecting accepts events; queued has one automation run; cancelled retains scrubbed history without a run.

One of"collecting""queued""cancelled"
group*array<||>
eventCount*integer
byteCount*integer
firstEventAt*string
lastEventAt*string
dispatchAfter*string
maxEvents*integer
maxWaitSeconds*integer
quietPeriodSeconds*integer|null
closedAt*string|null
reason*|null
runId*string|null
runStatus*|null
jamId*string|null
failure*string|null
curl -X POST 'https://api.capy.ai/api/v1/automations/string/batches/string/cancel'
{  "id": "string",  "automationId": "string",  "triggerId": "string",  "status": "collecting",  "group": [    "string"  ],  "eventCount": 0,  "byteCount": 0,  "firstEventAt": "string",  "lastEventAt": "string",  "dispatchAfter": "string",  "maxEvents": 0,  "maxWaitSeconds": 0,  "quietPeriodSeconds": 0,  "closedAt": "string",  "reason": "count",  "runId": "string",  "runStatus": "queued",  "jamId": "string",  "failure": "string"}
Open in Capy