# Blocked Handles

## List blocked handles

`blocked_handles.list()  -> BlockedHandleListResponse`

**get** `/v3/blocked_handles`

Returns all handles you have blocked. Inbound messages from a blocked
handle are dropped and produce no webhooks, and direct sends to a
blocked handle are rejected with `403` (error code `2026`). Group
sends that include unblocked members are not restricted.

### Returns

- `class BlockedHandleListResponse: …`

  - `blocked_handles: List[BlockedHandleEntry]`

    All handles blocked by the partner, newest first

    - `blocked_at: datetime`

      When the handle was blocked

    - `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

### Example

```python
import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
blocked_handles = client.blocked_handles.list()
print(blocked_handles.blocked_handles)
```

#### Response

```json
{
  "blocked_handles": [
    {
      "handle": "+12025551234",
      "reason": "spam",
      "blocked_at": "2026-07-30T16:42:00Z"
    }
  ]
}
```

## Block a handle

`blocked_handles.block(BlockedHandleBlockParams**kwargs)  -> BlockedHandleBlockResponse`

**post** `/v3/blocked_handles`

Blocks a handle — an E.164 phone number, an email address (iMessage
sender), an SMS short code (e.g. `262966`), or an alphanumeric sender
ID. Inbound messages from it are dropped and produce no webhooks, and
direct sends to it are rejected with `403` (error code `2026`); group
sends that include unblocked members are not restricted. Blocking is
idempotent — re-blocking an already blocked handle returns the
existing entry.

### Parameters

- `handle: str`

  The handle to block: an E.164 phone number, an email address, an
  SMS short code (3-8 digits), or an alphanumeric sender ID.

- `reason: Optional[str]`

  Optional free-text note on why the handle was blocked

### Returns

- `class BlockedHandleBlockResponse: …`

  - `blocked_handle: BlockedHandleEntry`

    - `blocked_at: datetime`

      When the handle was blocked

    - `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

### Example

```python
import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
response = client.blocked_handles.block(
    handle="+12025551234",
    reason="spam",
)
print(response.blocked_handle)
```

#### Response

```json
{
  "blocked_handle": {
    "handle": "+12025551234",
    "reason": "spam",
    "blocked_at": "2026-07-30T16:42:00Z"
  }
}
```

## Unblock a handle

`blocked_handles.unblock(BlockedHandleUnblockParams**kwargs)`

**delete** `/v3/blocked_handles`

Removes a handle from your blocklist. Inbound messages from it will be
delivered again and sends to it are allowed again. The handle goes in
the request body, mirroring block — no URL encoding needed.

### Parameters

- `handle: str`

  The handle to unblock

### Example

```python
import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
client.blocked_handles.unblock(
    handle="+12025551234",
)
```

#### Response

```json
{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format",
    "doc_url": "https://docs.linqapp.com/error/codes/1xxx/1002/"
  },
  "success": false
}
```

## Domain Types

### Blocked Handle Entry

- `class BlockedHandleEntry: …`

  - `blocked_at: datetime`

    When the handle was blocked

  - `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

### Blocked Handle List Response

- `class BlockedHandleListResponse: …`

  - `blocked_handles: List[BlockedHandleEntry]`

    All handles blocked by the partner, newest first

    - `blocked_at: datetime`

      When the handle was blocked

    - `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

### Blocked Handle Block Response

- `class BlockedHandleBlockResponse: …`

  - `blocked_handle: BlockedHandleEntry`

    - `blocked_at: datetime`

      When the handle was blocked

    - `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