Remove contact
API URL
URL used to send HTTP requests:
https://portal.bulkgate.com/api/1.0/address-book/remove
POST /api/1.0/address-book/remove HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache
Parameters table
PARAMETER NAME | VALUE | MANDATORY | DEFAULT VALUE |
---|---|---|---|
application_id | Application ID | Yes | - |
application_token | Application token | Yes | - |
phone_number | Phone number of contact to be removed. | Yes | - |
Example of full request
POST /api/1.0/address-book/remove HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache
{
"application_id": "####",
"application_token": "##################################################",
"phone_number": "123456789",
}
Response to this command may be:
In case of success:
{
"data": {
"message": "contact_has_been_removed"
}
}
In case of error:
{
"type": "number_not_found",
"code": 400,
"error": "Number not found",
"detail": null
}
{
"type": "invalid_phone_number",
"code": 400,
"error": "Invalid phone number",
"detail": null
}