# Import known-dead numbers

`POST /api/v1/phone/suppressions`

- Authentication: Secret API key as a bearer token
- Billing: Free.
- Group: Phone

Adds up to 10,000 numbers per request to the phone suppression list — an SMS provider's failure export, a hand-kept blocklist. Each item is a number in any notation or an object naming its own `country`; `country` at the top level applies to the rest. Numbers are normalised to E.164 first; ones that are not valid subscriber numbers (including national notation with no country) are counted as `invalid`. Entries that already exist are never overwritten and are counted as `already_suppressed`. Imported entries are honoured from day one at no credit cost: batch, bulk and monitor runs answer them with reason `suppressed`.

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | string[] | yes | 1 to 10,000 numbers, each a string of at most 32 characters or an object with its own country. |
| `items[].phone` | string | no | At most 32 characters. |
| `items[].country` | string | null | no | An ISO 3166-1 alpha-2 region code for this number. |
| `country` | string | null | no | The region for items written without a calling code that name none of their own. |

## Example request

```bash
curl -X POST https://spaw.co/api/v1/phone/suppressions \
  -H "Authorization: Bearer sk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "items": [
    "+1 415 201 0142",
    {
      "phone": "07911 012345",
      "country": "GB"
    }
  ]
}'
```

## Responses

### 200 — How many entries were added, already present, or not valid numbers.

```json
{
    "success": true,
    "data": {
        "added": 2,
        "already_suppressed": 0,
        "invalid": 0
    }
}
```

### 401 — The key is missing, malformed, or revoked.

```json
{
    "success": false,
    "error": {
        "code": "UNAUTHENTICATED",
        "message": "Provide a valid API key as a bearer token.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}
```

### 422 — The request body could not be validated; `error.errors` lists the fields.

```json
{
    "success": false,
    "error": {
        "code": "VALIDATION_FAILED",
        "message": "The email field is required.",
        "errors": {
            "email": [
                "The email field is required."
            ]
        },
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}
```

### 429 — Over 5 requests per second for the key. Retry after the limit resets.

```json
{
    "success": false,
    "error": {
        "code": "RATE_LIMITED",
        "message": "Too many requests. Retry after the limit resets.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}
```

## Error codes

- `UNAUTHENTICATED` — https://spaw.co/docs/errors/UNAUTHENTICATED
- `VALIDATION_FAILED` — https://spaw.co/docs/errors/VALIDATION_FAILED
- `RATE_LIMITED` — https://spaw.co/docs/errors/RATE_LIMITED

---

Canonical page: https://spaw.co/docs/api/add-phone-suppressions · OpenAPI document: https://spaw.co/openapi.json · All endpoints: https://spaw.co/docs/api