Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(api): say a running bulk batch is saved after every item

Yudhi Armyndharisf985e4aec22a
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index df18e3c48..10949c7a2 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -1596,7 +1596,7 @@ Get the processing status and progress of a bulk batch.
}
```
-`status` is one of `pending|processing|completed|cancelled|failed`; `results` holds one entry per recipient attempted as of the last saved checkpoint, with `status` `sent` or `failed`. While the batch is `processing`, the row is saved after the first recipient, every 10th recipient after it and the last, so `results` and `progress` can trail the send loop by up to 9 recipients; a recipient not yet attempted, or dropped by a cancel, appears only in the `progress` counters. A failed result carries a sanitized `error { code, message }` (internals are not leaked).
+`status` is one of `pending|processing|completed|cancelled|failed`; `results` holds one entry per recipient attempted as of the last saved checkpoint, with `status` `sent` or `failed`. While the batch is `processing`, the row is saved after every recipient, so `results` and `progress` trail the send loop by at most the recipient in flight, and a cancel from another node stops the run after at most one more recipient; a recipient not yet attempted, or dropped by a cancel, appears only in the `progress` counters. A failed result carries a sanitized `error { code, message }` (internals are not leaked).
**Errors:** `401` missing/invalid API key · `404` batch not found for this session