# Act on many numbers at once

Source: https://joinsimplesms.com/docs/api/numbers/bulk-update
Index: https://joinsimplesms.com/llms.txt

`POST /v1/numbers/bulk`

Tag, untag, label, pool, unpool or release up to 1000 numbers (100 for release). Returns 200 with a result per id even when some fail. Release requires `confirm: "RELEASE <count of ids>"`; test keys cannot release live numbers.

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 |
| --- | --- | --- | --- |
| `ids` | array of string | Yes | At most 1000 items. |
| `action` | `add_to_pool`, `remove_from_pool`, `add_tags`, `remove_tags`, `set_label`, `release` | Yes |  |
| `pool_id` | string | No | add_to_pool / remove_from_pool |
| `tags` | array of string | No | add_tags / remove_tags. Lowercased; up to 20 per number. |
| `label` | string | No | set_label; null clears At most 64 characters. Nullable. |
| `confirm` | string | No | release only Example: `RELEASE 2`. |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Per-id results | `BulkResult` |
| 400 | Malformed request or missing release confirmation | `Error` |
| 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: `BulkResult` fields

| Field | Type | Description |
| --- | --- | --- |
| `object` | `bulk_result` |  |
| `action` | string |  |
| `requested` | integer |  |
| `succeeded` | integer |  |
| `failed` | integer |  |
| `results` | array of object |  |
| `results[].id` | string |  |
| `results[].ok` | boolean |  |
| `results[].error` | `invalid_id`, `duplicate`, `not_found`, `too_many_tags`, `mode_mismatch`, `carrier_error` |  |
| `results[].message` | string |  |

## Errors

| Status | When |
| --- | --- |
| 400 | Malformed request or missing release confirmation |
| 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/numbers/bulk" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    "+15005550132",
    "+15005550154"
  ],
  "action": "add_to_pool",
  "confirm": "RELEASE 2"
}'
```

### Node.js

The Node.js SDK does not wrap this endpoint yet; call it with `fetch`.

```javascript
const res = await fetch('https://api.joinsimplesms.com/v1/numbers/bulk', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SIMPLESMS_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "ids": [
      "+15005550132",
      "+15005550154"
    ],
    "action": "add_to_pool",
    "confirm": "RELEASE 2"
  }),
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();
```

### Python

The Python SDK does not wrap this endpoint yet; call it over HTTP.

```python
import json, os, urllib.request

req = urllib.request.Request(
    "https://api.joinsimplesms.com/v1/numbers/bulk",
    method="POST",
    headers={
        "Authorization": f"Bearer {os.environ['SIMPLESMS_API_KEY']}",
        "Content-Type": "application/json",
    },
    data=json.dumps({
        "ids": [
            "+15005550132",
            "+15005550154"
        ],
        "action": "add_to_pool",
        "confirm": "RELEASE 2"
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    data = json.load(res)
```

## Related

- Guide: [Numbers](/docs/numbers)
- [All numbers endpoints](/docs/api#numbers)
- [API reference](/docs/api)