Fjerner et nummer fra blokkeringslisten, eller en hel gruppe numre etter `source_id`.

## API-URL

URL for sending av HTTP-forespørsler:

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

> [!NOTE]
> Hvis forespørselen ikke når frem, gjentar du den på [reserveserveren](https://www.bulkgate.com/no/dokumentasjon/api-administrasjon/api-reserveserver/) `backup1.bulkgate.com`.

## Støttede HTTP-metoder

- `POST` - `application/json`

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

## Parametertabell

| PARAMETERNAVN     | VERDI | OBLIGATORISK | STANDARDVERDI |
|:------------------|:------|:-----------------------|:---------------|
| application_id    | [Applikasjons-ID](https://www.bulkgate.com/no/dokumentasjon/api-administrasjon/administrasjon-av-api/) | **Ja** | - | 
| application_token | [Autentiseringstoken for applikasjonen](https://www.bulkgate.com/no/dokumentasjon/api-administrasjon/api-token/) | **Ja** | - |
| wallet            | Lommeboken numrene skal fjernes fra blokkeringslisten i | Nei | Standardlommebok |
| number            | Nummeret som skal fjernes fra blokkeringslisten | **Ja** eller `source_id` | - |
| source_id         | Identifikator for gruppen med numre som skal fjernes | **Ja** eller `number` | - |
| type              | Listen numrene fjernes fra – `black-list` eller `opt-out` | Nei | `black-list` |

> [!NOTE]
> Parameterne `number` og `source_id` kan ikke kombineres – bruk nøyaktig én av dem.

## Eksempel på forespørsel

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

## Svar

**Ved suksess:**

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

**Ved feil:**

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

Der:

- **type** og **error** (beskrivelse av feilen) finner du i [tabellen over feiltyper](https://www.bulkgate.com/no/dokumentasjon/api-administrasjon/api-feiltyper/)
- **code** er HTTP-feilkoden
- **detail** er tilleggsinformasjon om feilen

### Feiltyper i Blacklist API

I tillegg til de [generelle typene](https://www.bulkgate.com/no/dokumentasjon/api-administrasjon/api-feiltyper/) returnerer Blacklist API sine egne:

| TYPE                               | NÅR DET SKJER                                            |
|:-----------------------------------|:---------------------------------------------------------|
| `invalid_wallet`                   | Den angitte lommeboken finnes ikke, eller du har ikke tilgang til den. |
| `no_valid_numbers`                 | Ingen av de angitte numrene er gyldige.                  |
| `missing_parameters`               | Både `number` og `source_id` mangler.                    |
| `use_number_or_source_id_not_both` | `number` og `source_id` ble sendt sammen.                |
| `number_doesnt_exist`              | Nummeret står ikke på blokkeringslisten.                 |
| `invalid_number`                   | `number` er ikke et gyldig telefonnummer.                |