# Bulk-import a suppression list (up to 500 numbers)

Source: https://joinsimplesms.com/docs/api/consent/import
Index: https://joinsimplesms.com/llms.txt

`POST /v1/consent/import`

Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes.

## Request body

JSON (`Content-Type: application/json`).

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `phone_numbers` | array of string | Yes | At most 500 items. |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Import counts | JSON object |
| 401 | Missing, malformed, or revoked API key | `Error` |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: response fields

| Field | Type | Description |
| --- | --- | --- |
| `object` | string | Example: `consent_import`. |
| `imported` | integer |  |
| `skipped` | array of object |  |
| `skipped[].value` | string |  |
| `skipped[].reason` | string |  |

## Errors

| Status | When |
| --- | --- |
| 401 | Missing, malformed, or revoked API key |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged |
| 429 | Rate limit or quota exceeded |

Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it.

```json
{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}
```

## Examples

### curl

```bash
curl -X POST "https://api.joinsimplesms.com/v1/consent/import" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_numbers": [
    "+14155550132"
  ]
}'
```

### Node.js

```javascript
import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const result = await sms.consent.import(['+14155550132', '+14155550133']);
```

### Python

```python
import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

result = client.consent.import_(["+14155550132", "+14155550133"])
```

## Related

- Guide: [Opt-out, consent & TCPA](/docs/opt-out)
- [All consent endpoints](/docs/api#consent)
- [API reference](/docs/api)