Black List item removal

API URL

URL used to send HTTP requests:

https://portal.bulkgate.com/api/1.0/black-list/remove

POST /api/1.0/black-list/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-
walletWallet from which to remove blacklisted numbersNoDefault wallet
numberNumber to be removed from blacklistYes or source_id-
source_idIdentificator of group in blacklisted numbersYes or number-

Example of full request:

POST /api/1.0/black-list/remove HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",     
  "source_id": "api-my-import"
}

Response to this command may be:

In case of success:

{
    "data": {
        "message": "Black list contacts have been removed"
    }
}

In case of error:

{
    "type": "invalid_wallet",
    "code": 400,
    "error": "Invalid wallet",
    "detail": null
}

{
    "type": "no_valid_numbers",
    "code": 400,
    "error": "No valid numbers",
    "detail": null
}

{
    "type": "missing_parameters",
    "code": 400,
    "error": "Missing parameters",
    "detail": null
}

{
    "type": "use_number_or_source_id_not_both",
    "code": 400,
    "error": "Use number or source id not both",
    "detail": null
}

{
    "type": "use_number_or_source_id_not_both",
    "code": 400,
    "error": "Use number or source id not both",
    "detail": null
}

{
    "type": "number_doesnt_exist",
    "code": 400,
    "error": "Number doesn't exist",
    "detail": null
}

{
    "type": "invalid_number",
    "code": 400,
    "error": "Invalid number",
    "detail": null
}
← PreviousNext →