Legger numre til på blokkeringslisten. Et nummer på blokkeringslisten mottar verken markedsføringsmeldinger eller transaksjonsmeldinger.

## API-URL

URL for sending av HTTP-forespørsler:

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

> [!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/add 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** | - |
| numbers           | Numrene som skal legges på blokkeringslisten – en matrise eller en kommaseparert streng | **Ja** | - |
| wallet            | Lommeboken numrene skal blokkeres på | Nei | Standardlommebok |
| source_id         | Identifikator for gruppen med blokkerte numre | Nei | `api-<random string>` |
| reason            | Årsaken til at nummeret er lagt på blokkeringslisten | Nei | - |
| type              | Listen numrene legges på – `black-list` eller `opt-out` | Nei | `black-list` |

## Eksempel på forespørsel

```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": "Jeg ønsker ikke å motta markedsføringsmeldinger."
}
```

## Svar

**Ved suksess:**

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

**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": "number_already_exists",
    "code": 400,
    "error": "Number already exists",
    "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`      | Parameteren `numbers` inneholder ingen gyldige numre.               |
| `number_already_exists` | Du sender ett enkelt nummer, og det står allerede på blokkeringslisten. |