# Release a number

Source: https://jointextkit.com/docs/api/numbers/release
Index: https://jointextkit.com/llms.txt

`DELETE /v1/numbers/{id}`

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.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The E.164 number |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Number released | `Number` |
| 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` |
| 404 | Not found | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: `Number` fields

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | Example: `+15005550132`. |
| `object` | `number` |  |
| `phone_number` | string |  |
| `status` | `active`, `released` |  |
| `mode` | `test`, `live` |  |
| `created_at` | string (date-time) |  |
| `customer_id` | string | The customer this number is assigned to Nullable. |
| `label` | string | Nullable. |
| `tags` | array of string |  |
| `pools` | array of string | Pool ids |
| `sender` | object | How the number stands with the carriers. null on sandbox numbers and on numbers that need no registration (toll-free, Canadian). Only an active number can text anyone; in every other state it can text only your verified numbers. Nullable. |
| `sender.state` | `test_only`, `pending`, `active`, `action_needed` | test_only: no registration submitted. pending: a registration is in review, or approved and being linked. active: linked to an approved registration. action_needed: see reason. |
| `sender.registration_id` | string | The registration it is (being) linked to Nullable. |
| `sender.reason` | string | What to do, in plain words, when state is action_needed Nullable. |
| `sender.updated_at` | string (date-time) |  |
| `toll_free` | object | Toll-free verification, on live toll-free numbers only (null on every other number). Only a verified number texts anyone; its texts and STOP/HELP replies name `business`. Until the account has live access it texts only your verified numbers, verified or not; the carriers verifying it also verifies its business with us and gives a sandbox account live access. Nullable. |
| `toll_free.status` | `not_started`, `pending`, `verified`, `rejected` |  |
| `toll_free.business` | string | The business the verification names Nullable. |
| `toll_free.use_case` | string | Nullable. |
| `toll_free.verified_at` | string (date-time) | Nullable. |

## 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 |
| 404 | Not found |
| 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

### Node.js

```javascript
import { TextKit } from 'jointextkit'; // npm install jointextkit

const sms = new TextKit(process.env.TEXTKIT_API_KEY);

await sms.numbers.release('+14155550132');
```

### PHP

```php
<?php

$ch = curl_init('https://api.jointextkit.com/v1/numbers/+15005550132');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('TEXTKIT_API_KEY'),
    ],
]);

$data = json_decode(curl_exec($ch), true);
```

### Python

```python
import os
from jointextkit import TextKit  # pip install jointextkit

client = TextKit(os.environ["TEXTKIT_API_KEY"])

client.numbers.release("+14155550132")
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://api.jointextkit.com/v1/numbers/+15005550132")
req = Net::HTTP::Delete.new(uri)
req["Authorization"] = "Bearer #{ENV["TEXTKIT_API_KEY"]}"

res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.jointextkit.com/v1/numbers/+15005550132", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("TEXTKIT_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(data))
}
```

### Rust

```rust
// cargo add reqwest --features blocking,json
// cargo add serde_json

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let key = std::env::var("TEXTKIT_API_KEY")?;
    let res = reqwest::blocking::Client::new()
        .delete("https://api.jointextkit.com/v1/numbers/+15005550132")
        .bearer_auth(key)
        .send()?
        .error_for_status()?;
    let data: serde_json::Value = res.json()?;
    println!("{data}");
    Ok(())
}
```

### Java

```java
import java.net.URI;
import java.net.http.*;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder(URI.create("https://api.jointextkit.com/v1/numbers/+15005550132"))
            .header("Authorization", "Bearer " + System.getenv("TEXTKIT_API_KEY"))
            .DELETE()
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
```

### .NET

```csharp
using System.Net.Http.Headers;

var http = new HttpClient();
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("TEXTKIT_API_KEY"));

var res = await http.DeleteAsync("https://api.jointextkit.com/v1/numbers/+15005550132");
res.EnsureSuccessStatusCode();

var data = await res.Content.ReadAsStringAsync();
```

### cURL

```bash
curl -X DELETE "https://api.jointextkit.com/v1/numbers/+15005550132" \
  -H "Authorization: Bearer $TEXTKIT_API_KEY"
```

## Related

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