# Add a number to the do-not-call list

> POST /v1/do-not-call

From the next dial on, no agent rings it: a single call, a campaign's contact or a reminder to it is refused with `do_not_call`. Adding a listed number again answers `200` with the entry, taking the new `reason` if one is sent. Needs `do_not_call:write` and a live key.

## Body

Sent as JSON. A field this operation does not take is refused, so a typo fails loudly.

| Field | Type | Required | Description |
|---|---|---|---|
| `number` | string | Yes | The number, in international form. Spaces, dashes and brackets are ignored. |
| `reason` | string | No | Why, in your words. |

## Answer

`200` with [DoNotCallEntry](/reference/objects/DoNotCallEntry).
`201` with [DoNotCallEntry](/reference/objects/DoNotCallEntry).

## Errors

Every error is a [problem document](/errors) with a stable `code`.

| Status | When |
|---|---|
| `401` | The key is missing, mistyped, unknown, revoked or expired. |
| `403` | A test key, or a key limited to some projects or agents: the list decides which real people are called. |
| `422` | Not a phone number, or the list is full. |
| `429` | Too many requests for this key or its organization; see `Retry-After`. |
| `500` | Something went wrong on our side. Quote the `request_id` to support. |

## Examples

**curl**

```sh
#!/bin/sh
# Add a number to the do-not-call list. With a live key: the list decides which real people are called.
curl -sS --fail-with-body -X POST "https://api.aigently.ai/v1/do-not-call" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY" \
  --json '{
  "number": "+12025550188",
  "reason": "Asked not to be called again"
}'
```

**JavaScript**

```js
// Add a number to the do-not-call list. With a live key: the list decides which real people are called.
const response = await fetch("https://api.aigently.ai/v1/do-not-call", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.AIGENTLY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "number": "+12025550188",
    "reason": "Asked not to be called again"
  }),
});
const answer = await response.json();
if (!response.ok) throw new Error(`${answer.code}: ${answer.detail}`);
console.log(answer);
```

**Python**

```python
# Add a number to the do-not-call list. With a live key: the list decides which real people are called.
# pip install httpx
import os

import httpx

response = httpx.post(
    "https://api.aigently.ai/v1/do-not-call",
    headers={
        "Authorization": f"Bearer {os.environ['AIGENTLY_API_KEY']}",
    },
    json={
        "number": "+12025550188",
        "reason": "Asked not to be called again",
    },
)
if response.is_error:
    raise SystemExit(response.text)
print(response.json())
```

**Go**

```go
// Add a number to the do-not-call list. With a live key: the list decides which real people are called.
package main

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

func main() {
	payload := []byte(`{
  "number": "+12025550188",
  "reason": "Asked not to be called again"
}`)
	request, err := http.NewRequest("POST", "https://api.aigently.ai/v1/do-not-call", bytes.NewReader(payload))
	if err != nil {
		panic(err)
	}
	request.Header.Set("Authorization", "Bearer "+os.Getenv("AIGENTLY_API_KEY"))
	request.Header.Set("Content-Type", "application/json")
	response, err := http.DefaultClient.Do(request)
	if err != nil {
		panic(err)
	}
	defer response.Body.Close()
	body, _ := io.ReadAll(response.Body)
	if response.StatusCode >= 400 {
		fmt.Fprintln(os.Stderr, string(body))
		os.Exit(1)
	}
	fmt.Println(string(body))
}
```

**Java**

```java
// Add a number to the do-not-call list. With a live key: the list decides which real people are called.
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "number": "+12025550188",
              "reason": "Asked not to be called again"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.aigently.ai/v1/do-not-call"))
            .header("Authorization", "Bearer " + System.getenv("AIGENTLY_API_KEY"))
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        // HTTP/1.1: on a plain-http address Java's default asks to upgrade, which not every
        // server allows.
        HttpClient client = HttpClient.newBuilder().version(HttpClient.Version.HTTP_1_1).build();
        HttpResponse<String> response =
            client.send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 400) {
            System.err.println(response.body());
            System.exit(1);
        }
        System.out.println(response.body());
    }
}
```

**C#**

```csharp
// Add a number to the do-not-call list. With a live key: the list decides which real people are called.
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AIGENTLY_API_KEY"));
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.aigently.ai/v1/do-not-call")
{
    Content = new StringContent(
        """
        {
          "number": "+12025550188",
          "reason": "Asked not to be called again"
        }
        """,
        Encoding.UTF8,
        "application/json"),
};
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
{
    Console.Error.WriteLine(body);
    return 1;
}
Console.WriteLine(body);
return 0;
```

**PHP**

```php
<?php
// Add a number to the do-not-call list. With a live key: the list decides which real people are called.
$curl = curl_init("https://api.aigently.ai/v1/do-not-call");
curl_setopt_array($curl, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("AIGENTLY_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "number" => "+12025550188",
        "reason" => "Asked not to be called again",
    ]),
]);
$body = curl_exec($curl);
if (curl_getinfo($curl, CURLINFO_RESPONSE_CODE) >= 400) {
    fwrite(STDERR, $body . "\n");
    exit(1);
}
echo $body, "\n";
```