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 NAMEVALUEMANDATORYDEFAULT VALUE
application_idApplication IDYes-
application_tokenApplication tokenYes-
phone_numberPhone 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
}

Where:

  • type and error (description of the error) can be found in the error types table,
  • code represents http error
  • detail is an additional info about the error

See all the error types for Simple API and Advanced API here.

← Previous