Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(api): note that contact addressbook writes need OPERATOR

Yudhi Armyndharis892bd91486e5
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index e0cc815c1..2e4446fe4 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -2383,7 +2383,7 @@ Cancel a running (pending/processing) bulk batch. No request body.
### 6.4.3 Contacts
-Contact endpoints are scoped under a session: `/api/sessions/:sessionId/contacts`. All read routes require a valid API key, except the number check (`GET .../check/:number`), which requires an `OPERATOR` key because each call queries WhatsApp about a third party and bulk checks put the linked account's standing at risk; the block/unblock writes require an `OPERATOR` key. Every route returns `400 "Session is not started"` when the session has no running engine (missing or stopped); a started session whose engine is not ready yet (initializing, waiting for QR, reconnecting) answers `409` (retryable). Responses are the raw handler payload (no envelope).
+Contact endpoints are scoped under a session: `/api/sessions/:sessionId/contacts`. All read routes require a valid API key, except the number check (`GET .../check/:number`), which requires an `OPERATOR` key because each call queries WhatsApp about a third party and bulk checks put the linked account's standing at risk; every write (saving or removing an addressbook entry with `PUT`/`DELETE` `/:contactId`, block and unblock) requires an `OPERATOR` key. Every route returns `400 "Session is not started"` when the session has no running engine (missing or stopped); a started session whose engine is not ready yet (initializing, waiting for QR, reconnecting) answers `409` (retryable). Responses are the raw handler payload (no envelope).
The `Contact` object returned by the list and get-by-id routes has this shape: