Block WhatsApp users
https://api.app2email.com/v1/{number}/blocked They cannot message the number and it cannot message them. Up to 1000 per call; only users who wrote in the last 24 hours.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Body application/json required
-
Phone numbers (country code, digits) or business-scoped user ids. Meta's own block_users list works too.
Responses
Fields
- success boolean
false when some users failed (HTTP 207).
- request_id string
- blocked object[]
POST only.
- unblocked object[]
DELETE only.
- failed object[]
4 item fields
- input string
- wa_id string
- user_id string
- error object
4 fields
- code string
- message string
- how_to_fix string
- whatsapp_code integer
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 422 The request is understood but cannot be sent (template parameters, media, text, recipient, or a WhatsApp rule such as the 24 hour window).
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.
- 502 WhatsApp (Meta) returned an error or could not be reached.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.