## API URL

Adresa URL, ktorá sa používa na odosielanie HTTP požiadaviek:

```url
https://portal.bulkgate.com/api/1.0/address-book/remove
```

> [!NOTE]
> Ak sa požiadavka nedostane k cieľu, 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/address-book/remove 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**  | -                  |
| phone_number      | Telefónne číslo odstraňovaného kontaktu                | **Áno**  | -                  |
| category          | Adresár, s ktorým sa pracuje. Predvolený je hlavný adresár účtu. | Nie | `main`          |


## Príklad požiadavky

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

{
	"application_id": 451,
	"application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
	"phone_number": "123456789"
}
```

## Odpoveď

**V prípade úspechu:**
```json
{
    "data": {
        "message": "contact_has_been_removed"
    }
}
```


**V prípade chyby:**
```json
{
    "type": "number_not_found",
    "code": 400,
    "error": "Number not found",
    "detail": null
}
```

```json
{
    "type": "invalid_phone_number",
    "code": 400,
    "error": "Invalid phone number",
    "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