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

client.blockedHandles.list(?): BlockedHandleListResponse { blocked_handles }

GET/v3/blocked_handles

Block a handle

client.blockedHandles.block(, ?): BlockedHandleBlockResponse { blocked_handle }

POST/v3/blocked_handles

Unblock a handle

client.blockedHandles.unblock(, ?): void

DELETE/v3/blocked_handles

ModelsExpand Collapse

BlockedHandleEntry { blocked_at, handle, reason }

blocked_at: string

When the handle was blocked

formatdate-time

handle: string

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

reason?: string

Optional note recorded when the handle was blocked

BlockedHandleListResponse { blocked_handles }

blocked_handles: Array<BlockedHandleEntry { blocked_at, handle, reason } >

All handles blocked by the partner, newest first

blocked_at: string

When the handle was blocked

formatdate-time

handle: string

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

reason?: string

Optional note recorded when the handle was blocked

BlockedHandleBlockResponse { blocked_handle }

blocked_handle: BlockedHandleEntry { blocked_at, handle, reason }

blocked_at: string

When the handle was blocked

formatdate-time

handle: string

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

reason?: string

Optional note recorded when the handle was blocked