## URL de la API
URL utilizada para enviar las solicitudes HTTP:
```url
https://portal.bulkgate.com/api/1.0/address-book/remove
```

> [!NOTE]
> Si la solicitud no llega a su destino, repítala en el [servidor de respaldo](https://www.bulkgate.com/es/documentacion/administracion-de-la-api/servidor-de-respaldo/) `backup1.bulkgate.com`.


## Métodos HTTP compatibles

- `POST` - `application/json`

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

## Tabla de parámetros

| NOMBRE DEL PARÁMETRO | VALOR | OBLIGATORIO | VALOR PREDETERMINADO |
|:--- |:--- |:--- |:--- |
|application_id| [Application ID](https://www.bulkgate.com/es/documentacion/administracion-de-la-api/administracion-api/) |**Sí**|-|
|application_token| [Application token](https://www.bulkgate.com/es/documentacion/administracion-de-la-api/tokens-de-api/) |**Sí**|-|
|phone_number| Número de teléfono del contacto que se va a eliminar. |**Sí**|-|
| category | La agenda de contactos con la que se trabaja. De forma predeterminada, la principal de la cuenta. | No | `main` |


## Ejemplo de solicitud

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

## Respuesta

**En caso de éxito:**
```json
{
    "data": {
        "message": "contact_has_been_removed"
    }
}
```


**En caso de error:**
```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
}
```

Donde:

- **type** y **error** (descripción del error) se encuentran en la [tabla de tipos de error](https://www.bulkgate.com/es/documentacion/administracion-de-la-api/tipos-de-error/)
- **code** representa el error HTTP
- **detail** es información adicional sobre el error