Pridá čísla do blacklistu. Na číslo v blackliste neodíde propagačná ani transakčná správa.

## API URL

Adresa URL, na ktorú sa posielajú požiadavky HTTP:

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

> [!NOTE]
> Ak sa požiadavka nedostane do cieľa, zopakujte ju na [záložnom serveri](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/zalozny-server/) `backup1.bulkgate.com`.

## Podporované HTTP metódy

- `POST` - `application/json`

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

## Tabuľka s parametrami

| NÁZOV PARAMETRA   | HODNOTA                                                | POVINNÝ | PREDVOLENÁ HODNOTA   |
|:------------------|:-------------------------------------------------------|:--------|:------------------|
| application_id    | [Identifikátor aplikácie](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/administracia-api/) | **Áno** | -                 | 
| application_token | [Overovací token aplikácie](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/api-tokeny/)	      | **Áno** | -                 |
| numbers           | Čísla na zaradenie do blacklistu — pole alebo reťazec oddelený čiarkami | **Áno** | -            |
| wallet            | Peňaženka, v ktorej sa čísla pridajú do blacklistu  | Nie      | Predvolená peňaženka |
| source_id         | Identifikátor skupiny čísel pridaných do blacklistu	   | Nie      | `api-<náhodný reťazec>` |
| reason            | Dôvod zaradenia čísla do blacklistu                     | Nie      | -                 |
| type              | Zoznam, do ktorého sa čísla zaradia — `black-list` alebo `opt-out` | Nie | `black-list`   |

## Príklad požiadavky

```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": "Nechcem dostávať obchodné oznámenia."
}
```

## Odpoveď

**V prípade úspechu:**

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

**V prípade chyby:**

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

Kde:

- **type** a **error** (popis chyby) nájdete v [tabuľke typov chýb](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/typy-chyb-api/)
- **code** je HTTP kód chyby
- **detail** je doplňujúca informácia o chybe

### Typy chýb Blacklist API

Popri [všeobecných typoch](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/typy-chyb-api/) vracia Blacklist API vlastné:

| TYP                     | KEDY NASTANE                                                        |
|:------------------------|:--------------------------------------------------------------------|
| `invalid_wallet`        | Zadaná peňaženka neexistuje alebo k nej nemáte prístup.               |
| `no_valid_numbers`      | V parametri `numbers` nie je žiadne platné číslo.                      |
| `number_already_exists` | Odosielate jediné číslo a to už v blackliste je.                     |