Unsubscribe · BulkGate Helpdesk

API URL

URL used to send HTTP requests:

https://portal.bulkgate.com/api/1.0/subscribe/unsubscribe

POST /api/1.0/subscribe/unsubscribe 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	-
group	Recipient group	Yes	-
identification	Channel identification	Yes	-

Example of full request

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

{
    "application_id": "####",
    "application_token": "##################################################",
    "group": 1,
  "identification": ["telegram:########", "line:################"]
}

Response to this command may be:

In case of success:

{
    "data": {
        "message": "users_unsubscribed"
    }
}

In case of error:

{
    "type": "invalid_identification",
    "code": 400,
    "error": "Invalid identification",
    "detail": null
}

{
    "type": "too_many_subscribers_to_remove",
    "code": 400,
    "error": "Too many subscribers to remove",
    "detail": null
}