Añade números a la blacklist. Un número incluido en la blacklist no recibe mensajes promocionales ni transaccionales.

## URL de la API

URL a la que se envían las solicitudes HTTP:

```url
https://portal.bulkgate.com/api/1.0/black-list/add
```

> [!NOTE]
> Si la solicitud no llega a su destino, repítala en el [servidor de respaldo](https://www.bulkgate.com/es/documentacion/administracion-de-la-api/servidor-de-respaldo/) `backup1.bulkgate.com`.

## Métodos HTTP admitidos

- `POST` - `application/json`

```http
POST /api/1.0/black-list/add HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
```

## Tabla de parámetros

| NOMBRE DEL PARÁMETRO | VALOR | OBLIGATORIO | VALOR PREDETERMINADO |
|:------------------|:---------------------------------------------------------|:----------|:---------------|
| application_id    | [ID de aplicación](https://www.bulkgate.com/es/documentacion/administracion-de-la-api/administracion-api/)           | **Sí**   | -              |
| application_token | [Token de autenticación de la aplicación](https://www.bulkgate.com/es/documentacion/administracion-de-la-api/tokens-de-api/) | **Sí**   | -              |
| numbers           | Números que se van a incluir en la blacklist: un array o una cadena separada por comas | **Sí** | -              |
| wallet            | Monedero en el que se incluyen los números en la blacklist                | No        | Monedero predeterminado |
| source_id         | Identificador del grupo de números incluidos en la blacklist         | No        | `api-<random string>` |
| reason            | Motivo por el que el número se incluye en la blacklist                 | No        | -              |
| type              | Lista a la que se añaden los números: `black-list` u `opt-out`  | No        | `black-list`   |

## Ejemplo de solicitud

```http-json
POST /api/1.0/black-list/add HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json

{
  "application_id": 451,
  "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
  "numbers": ["420123456789", "420987654321"],
  "wallet": "bg1905014138000023",
  "source_id": "api-my-import",
  "reason": "No quiero recibir comunicaciones comerciales."
}
```

## Respuesta

**En caso de éxito:**

```json
{
    "data": {
        "message": "contacts have been blacklisted"
    }
}
```

**En caso de error:**

```json
{
    "type": "invalid_wallet",
    "code": 400,
    "error": "Invalid wallet",
    "detail": null
}
```

```json
{
    "type": "no_valid_numbers",
    "code": 400,
    "error": "No valid numbers",
    "detail": null
}
```

```json
{
    "type": "number_already_exists",
    "code": 400,
    "error": "Number already exists",
    "detail": null
}
```

Donde:

- **type** y **error** (descripción del error) se encuentran en la [tabla de tipos de error](https://www.bulkgate.com/es/documentacion/administracion-de-la-api/tipos-de-error/)
- **code** es el código de error HTTP
- **detail** es información adicional sobre el error

### Tipos de error de la Blacklist API

Además de los [tipos generales](https://www.bulkgate.com/es/documentacion/administracion-de-la-api/tipos-de-error/), la Blacklist API devuelve sus propios tipos:

| TIPO                    | CUÁNDO SE PRODUCE                                                   |
|:------------------------|:--------------------------------------------------------------------|
| `invalid_wallet`        | El monedero indicado no existe o no tiene acceso a él.              |
| `no_valid_numbers`      | El parámetro `numbers` no contiene ningún número válido.            |
| `number_already_exists` | Está enviando un único número y ya está en la blacklist.            |