Ajoute des numéros à la blacklist. Un numéro en blacklist ne reçoit ni messages promotionnels ni messages transactionnels.

## URL de l'API

URL utilisée pour envoyer les requêtes HTTP :

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

> [!NOTE]
> Si la requête n'atteint pas sa destination, renvoyez-la sur le [serveur de secours](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/serveur-de-secours/) `backup1.bulkgate.com`.

## Méthodes HTTP prises en charge

- `POST` - `application/json`

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

## Tableau des paramètres

| NOM DU PARAMÈTRE    | VALEUR                                                   | OBLIGATOIRE | VALEUR PAR DÉFAUT  |
|:------------------|:---------------------------------------------------------|:----------|:---------------|
| application_id    | [ID de l'application](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/administration-api/)           | **Oui**   | -              | 
| application_token | [Token d'authentification de l'application](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/tokens-d-api/)	 | **Oui**   | -              |
| numbers           | Numéros à mettre en blacklist — un tableau ou une chaîne séparée par des virgules | **Oui** | -              |
| wallet            | Portefeuille sur lequel les numéros sont mis en blacklist | Non        | Portefeuille par défaut |
| source_id         | Identifiant du groupe de numéros mis en blacklist	     | Non        | `api-<chaîne aléatoire>` |
| reason            | Motif de la mise en blacklist du numéro	                 | Non        | -              |
| type              | Liste dans laquelle vont les numéros — `black-list` ou `opt-out` | Non        | `black-list`   |

## Exemple de requête

```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": "Je ne souhaite pas recevoir de communications commerciales."
}
```

## Réponse

**En cas de succès :**

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

**En cas d'erreur :**

```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
}
```

Où :

- **type** et **error** (description de l'erreur) figurent dans le [tableau des types d'erreurs](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/types-d-erreurs-api/)
- **code** est le code d'erreur HTTP
- **detail** est une information complémentaire sur l'erreur

### Types d'erreurs de la Blacklist API

Outre les [types généraux](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/types-d-erreurs-api/), la Blacklist API renvoie ses propres types :

| TYPE                    | QUAND CELA SE PRODUIT                                               |
|:------------------------|:--------------------------------------------------------------------|
| `invalid_wallet`        | Le portefeuille indiqué n'existe pas ou vous n'y avez pas accès.    |
| `no_valid_numbers`      | Le paramètre `numbers` ne contient aucun numéro valide.             |
| `number_already_exists` | Vous envoyez un seul numéro et il figure déjà dans la blacklist.    |