Odstráni skrátený odkaz z portálu BulkGate. Odkaz po zmazaní prestane presmerovávať, a to aj v už odoslaných správach, v ktorých je použitý.

## API URL

Adresa URL používaná na odosielanie HTTP požiadaviek:

```url
https://portal.bulkgate.com/api/1.0/shortener/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/shortener/remove HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
```

> [!NOTE]
> API má nastavenú kvótu `20` požiadaviek za minútu.

## Tabuľka s parametrami

| NÁZOV PARAMETRA   | HODNOTA                                                | POVINNÝ | PREDVOLENÁ HODNOTA |
|:------------------|:-------------------------------------------------------|:--------|:-------------------|
| application_id    | [Aplikačný identifikátor](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/administracia-api/) | **Áno** | -                  | 
| application_token | [Aplikačný overovací token](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/api-tokeny/)	      | **Áno** | -                  |
| short_url         | Skrátená URL, ktorá sa má odstrániť	                 | **Áno** | -                  |

## Príklad požiadavky

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

{
  "application_id": 451,
  "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
  "short_url": "http://ur7.wf/W/1"
}
```

## Odpoveď

**V prípade úspechu:**

```json
{
    "data": {
        "short_url": "http://ur7.wf/W"
    }
}
```

**V prípade chyby:**

```json
{
    "type": "url_not_found",
    "code": 400,
    "error": "Url not found",
    "detail": null
}
```

```json
{
    "type": "the_per_minute_quota_has_been_exceeded",
    "code": 400,
    "error": "The per minute quota has been exceeded",
    "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 Shortener API

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

| TYP                                     | KEDY NASTANE                                                           |
|:----------------------------------------|:-----------------------------------------------------------------------|
| `url_not_found`                         | `short_url` v účte neexistuje.                                         |
| `the_per_minute_quota_has_been_exceeded`| Vyčerpaná kvóta 20 požiadaviek za minútu.                              |