# Create an Opt-Out

Add a phone number to the opt-out list. Once opted out, the recipient will no longer receive messages.

### <mark style="color:green;">`POST`</mark> `/addressbook/optouts`&#x20;

#### Required Permission

```
create:Optouts
```

Your API key must have this permission enabled in order to use this endpoint.

#### Example Request

```bash
curl --location 'https://<hostname>/addressbook/optouts' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "msisdn": "55555555555"
  }'
```

Replace `YOUR_API_KEY` with your API key.

{% hint style="info" %}
All endpoints shown in this documentation use a **sample base URL**. The production API endpoint is provided by our team upon request.
{% endhint %}

#### Request Parameters

| Field    | Type   | Required | Description                                     |
| -------- | ------ | -------- | ----------------------------------------------- |
| `msisdn` | string | Yes      | Phone number to opt out (international format). |

#### Success Response (HTTP 200)

```json
{
  "success": true
}
```