Fjerner en kort lenke fra BulkGate-portalen. Når lenken er slettet, slutter den å videresende, også i meldinger som allerede er sendt med den.

## API-URL

URL for sending av HTTP-forespørsler:

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

> [!NOTE]
> Hvis forespørselen ikke kommer frem, kan du gjenta 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/shortener/remove HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
```

> [!NOTE]
> API-et har en kvote på `20` forespørsler per minutt.

## 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**    | -             |
| short_url         | Forkortet URL som skal fjernes	                          | **Ja**    | -             |

## Eksempel på forespørsel

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

## Svar

**Ved suksess:**

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

**Ved feil:**

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

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 Shortener API

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

| TYPE                                    | NÅR DEN OPPSTÅR                                                        |
|:----------------------------------------|:-----------------------------------------------------------------------|
| `url_not_found`                         | `short_url` finnes ikke i kontoen.                                     |
| `the_per_minute_quota_has_been_exceeded`| Kvoten på 20 forespørsler per minutt er brukt opp.                     |