Blocked Handles

Block handles — phone numbers, email addresses, SMS short codes, or sender IDs. Inbound messages from a blocked handle are dropped before they reach your webhooks, and direct sends to a blocked handle are rejected with 403 (error code 2026). Group sends that include unblocked members are not restricted.

List blocked handles

blocked_handles.list() -> BlockedHandleListResponse

GET/v3/blocked_handles

Block a handle

blocked_handles.block() -> BlockedHandleBlockResponse

POST/v3/blocked_handles

Unblock a handle

blocked_handles.unblock()

DELETE/v3/blocked_handles

ModelsExpand Collapse

class BlockedHandleEntry: …

blocked_at: datetime

When the handle was blocked

formatdate-time

handle: str

The blocked handle, normalized (E.164 phone, lowercased email, short code, or sender ID)

reason: Optional[str]

Optional note recorded when the handle was blocked

class BlockedHandleListResponse: …

blocked_handles: List[BlockedHandleEntry]

All handles blocked by the partner, newest first

blocked_at: datetime

When the handle was blocked

formatdate-time

handle: str

The blocked handle, normalized (E.164 phone, lowercased email, short code, or sender ID)

reason: Optional[str]

Optional note recorded when the handle was blocked

class BlockedHandleBlockResponse: …

blocked_handle: BlockedHandleEntry

blocked_at: datetime

When the handle was blocked

formatdate-time

handle: str

The blocked handle, normalized (E.164 phone, lowercased email, short code, or sender ID)

reason: Optional[str]

Optional note recorded when the handle was blocked