Odstraní zkrácený odkaz z portálu BulkGate. Odkaz po smazání přestane přesměrovávat, včetně už odeslaných zpráv, ve kterých je použitý.

## API URL

Adresa URL používaná k odeslání požadavků HTTP:

```url
https://portal.bulkgate.com/api/1.0/shortener/remove
```

> [!NOTE]
> Nedostane-li se požadavek k cíli, zopakujte ho na [záložním serveru](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/zalozni-server/) `backup1.bulkgate.com`.

## Podporované HTTP metody

- `POST` - `application/json`

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

> [!NOTE]
> API má nastavenou kvótu na `20` požadavků za minutu.

## Tabulka s parametry

| NÁZEV PARAMETRU   | HODNOTA                                                | POVINNÝ | VÝCHOZÍ HODNOTA |
|:------------------|:-------------------------------------------------------|:--------|:----------------|
| application_id    | [Aplikační identifikátor](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/administrace-api/) | **Ano** | -               | 
| application_token | [Aplikační ověřovací token](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/api-tokeny/)	      | **Ano** | -               |
| short_url         | Zkrácená url, která má být odstraněna	                 | **Ano** | -               |

## Příklad požadavku

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

## Odpověď

**V případě úspěchu:**

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

**V případě 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) najdete v [tabulce typů chyb](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/typy-chyb-api/)
- **code** je HTTP kód chyby
- **detail** je doplňující informace o chybě

### Typy chyb Shortener API

Vedle [obecných typů](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/typy-chyb-api/) vrací Shortener API vlastní:

| TYP                                     | KDY NASTANE                                                           |
|:----------------------------------------|:-----------------------------------------------------------------------|
| `url_not_found`                         | `short_url` v účtu neexistuje.                                         |
| `the_per_minute_quota_has_been_exceeded`| Vyčerpaná kvóta 20 požadavků za minutu.                                |