Entfernt eine Nummer von der Blacklist oder eine ganze Gruppe von Nummern anhand von `source_id`.

## API-URL

URL, an die HTTP-Anfragen gesendet werden:

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

> [!NOTE]
> Erreicht die Anfrage ihr Ziel nicht, wiederholen Sie sie auf dem [Backup-Server](https://www.bulkgate.com/de/dokumentation/api-verwaltung-und-tokens/backup-server/) `backup1.bulkgate.com`.

## Unterstützte HTTP-Methoden

- `POST` - `application/json`

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

## Parametertabelle

| PARAMETERNAME | WERT | PFLICHT | STANDARDWERT |
|:------------------|:---------------------------------------------------------|:-----------------------|:---------------|
| application_id | [Anwendungs-ID](https://www.bulkgate.com/de/dokumentation/api-verwaltung-und-tokens/api-verwaltung/) | **Ja** | - |
| application_token | [Authentifizierungstoken der Anwendung](https://www.bulkgate.com/de/dokumentation/api-verwaltung-und-tokens/api-tokens/) | **Ja** | - |
| wallet | Wallet, aus dem die Nummern von der Blacklist entfernt werden | Nein | Standard-Wallet |
| number | Nummer, die von der Blacklist entfernt werden soll | **Ja** oder `source_id` | - |
| source_id | Kennung der Gruppe von Nummern, die entfernt werden soll | **Ja** oder `number` | - |
| type | Liste, aus der die Nummern entfernt werden – `black-list` oder `opt-out` | Nein | `black-list` |

> [!NOTE]
> Die Parameter `number` und `source_id` lassen sich nicht kombinieren – verwenden Sie genau einen davon.

## Beispielanfrage

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

{
  "application_id": 451,
  "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
  "wallet": "bg1905014138000023",
  "source_id": "api-my-import"
}
```

## Antwort

**Bei Erfolg:**

```json
{
    "data": {
        "message": "Black list contacts have been removed"
    }
}
```

**Bei einem Fehler:**

```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": "missing_parameters",
    "code": 400,
    "error": "Missing parameters",
    "detail": null
}
```

```json
{
    "type": "use_number_or_source_id_not_both",
    "code": 400,
    "error": "Use number or source id not both",
    "detail": null
}
```

```json
{
    "type": "number_doesnt_exist",
    "code": 400,
    "error": "Number doesnt exist",
    "detail": null
}
```

```json
{
    "type": "invalid_number",
    "code": 400,
    "error": "Invalid number",
    "detail": null
}
```

Dabei gilt:

- **type** und **error** (Beschreibung des Fehlers) finden Sie in der [Tabelle der Fehlertypen](https://www.bulkgate.com/de/dokumentation/api-verwaltung-und-tokens/api-fehlertypen/)
- **code** ist der HTTP-Fehlercode
- **detail** enthält zusätzliche Informationen zum Fehler

### Fehlertypen der Blacklist API

Neben den [allgemeinen Typen](https://www.bulkgate.com/de/dokumentation/api-verwaltung-und-tokens/api-fehlertypen/) gibt die Blacklist API eigene zurück:

| TYP | WANN ER AUFTRITT |
|:-----------------------------------|:---------------------------------------------------------|
| `invalid_wallet` | Das angegebene Wallet existiert nicht oder Sie haben keinen Zugriff darauf. |
| `no_valid_numbers` | Keine der angegebenen Nummern ist gültig. |
| `missing_parameters` | Sowohl `number` als auch `source_id` fehlen. |
| `use_number_or_source_id_not_both` | `number` und `source_id` wurden gemeinsam gesendet. |
| `number_doesnt_exist` | Die Nummer steht nicht auf der Blacklist. |
| `invalid_number` | `number` ist keine gültige Telefonnummer. |