## URL de l'API
URL utilisée pour l'envoi des requêtes HTTP :
```url
https://portal.bulkgate.com/api/1.0/address-book/remove
```

> [!NOTE]
> Si la requête n'atteint pas sa destination, renvoyez-la sur le [serveur de secours](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/serveur-de-secours/) `backup1.bulkgate.com`.


## Méthodes HTTP prises en charge

- `POST` - `application/json`

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

## Tableau des paramètres

| NOM DU PARAMÈTRE | VALEUR | OBLIGATOIRE | VALEUR PAR DÉFAUT |
|:--- |:--- |:--- |:--- |
|application_id| [ID d'application](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/administration-api/) |**Oui**|-| 
|application_token| [Jeton d'application](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/tokens-d-api/)	|**Oui**|-|
|phone_number| Numéro de téléphone du contact à supprimer. |**Oui**|-|
| category          | Carnet d'adresses à utiliser. Par défaut, le carnet principal du compte. | Non       | `main`                      |


## Exemple de requête

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

## Réponse

**En cas de succès :**
```json
{
    "data": {
        "message": "contact_has_been_removed"
    }
}
```


**En cas d'erreur :**
```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
}
```

Où :

- **type** et **error** (description de l'erreur) sont décrits dans le [tableau des types d'erreurs](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/types-d-erreurs-api/)
- **code** représente le code d'erreur HTTP
- **detail** contient des informations complémentaires sur l'erreur