Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(api): list every contact id the addressbook routes refuse
Yudhi Armyndharisab5d1b52856e
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.mdindex b553650aa..9b9fb10c0 100644--- a/docs/06-api-specification.md+++ b/docs/06-api-specification.md@@ -2624,9 +2624,10 @@ contact record — it does not block, delete, or otherwise touch the chat.> **A privacy id (`…@lid`) is refused with `400`.** The addressbook is keyed by phone number, and a> lid's digits are not one — whatsapp-web.js takes a bare number here, so an unguarded lid would be-> stored as if it were a real phone. Pass a phone-based contact id instead.+> stored as if it were a real phone. Pass a phone-based contact id instead. Any other id that does not+> name a person (a group, newsletter, broadcast or non-numeric id) is refused with `400` as well.-**Errors:** `400` session not active, invalid request, or a `@lid` contact id · `401` missing/invalid API key · `403` key lacks OPERATOR role · `409` conflict or engine not ready (retryable) · `503` session not ready or dependency unavailable (retryable)+**Errors:** `400` session not active, invalid request, or the contact id does not name a phone-based individual (a `@lid`, group, newsletter, broadcast or non-numeric id) · `401` missing/invalid API key · `403` key lacks OPERATOR role · `409` conflict or engine not ready (retryable) · `503` session not ready or dependency unavailable (retryable)#### DELETE /api/sessions/:sessionId/contacts/:contactId@@ -2636,7 +2637,7 @@ Remove a contact from the account's addressbook. Does not block the contact or d**Response** `200` — `{ "success": true, "message": "Contact deleted" }`-**Errors:** `400` session not active, or a `@lid` contact id (same reason as the `PUT` above) · `401` missing/invalid API key · `403` key lacks OPERATOR role · `409` conflict or engine not ready (retryable) · `503` session not ready or dependency unavailable (retryable)+**Errors:** `400` session not active, or the contact id does not name a phone-based individual (a `@lid`, group, newsletter, broadcast or non-numeric id; same reason as the `PUT` above) · `401` missing/invalid API key · `403` key lacks OPERATOR role · `409` conflict or engine not ready (retryable) · `503` session not ready or dependency unavailable (retryable)#### POST /api/sessions/:sessionId/contacts/:contactId/block