Skip to main content
POST
whatsapp.user.block

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
phone
string
required

Phone number whose messages will be blocked.

Pattern: ^\+[1-9]\d{1,14}$
accountId
string

The sending account, from social.accounts.list. Optional when only one is connected.

Required string length: 1 - 256

Response

The result

blocked
boolean
required

The person can no longer message this sender.

ref
string

Reference to what this call created. Pass it as ref to whatsapp.user.unblock.