Unsubscribe a subscriber from the database
The following errors can occur:
- Token not present in request.
- Token not in the required format.
- Session does not exist.
- Session has expired.
- The user does not exist.
- No database specified.
- Database parameter not in correct format.
- You are not allowed to access this database.
- The selected subscriber is unsubscribed, but we failed to forget the subscriber
You should call this function as followed:
- rest/v2/subscriber/unsubscribe?token=TOKEN&database=DATABASE_ID&id=SUBSCRIBER_ID&performed=subscriber&reason=STRING&forget=INTEGER
require_once 'Rest.php';
$username = 'my_username';
$password = 'my_password';
$database = '999';
$rest = new Rest($username, $password, $database);
$result = $rest->call('subscriber/unsubscribe', [
'id' => 'SUBSCRIBER_ID',
'performed' => 'subscriber',
'reason' => 'STRING',
'forget' => 'INTEGER'
], 'GET');
var_dump($result);
The following parameters this method can/should be called with:
key: id
values: integer, required
what: The ID of the subscriber
key: performed
values: string ('subscriber' or 'listowner'), standard uses 'subscriber', not required
what: By who is this action performed
key: reason
values: string, not required
what: What is the reason of the unsubscribe
key: forget
values: Integer, 1 or 0
what: Do you want to forget the subscriber and delete all data following the GDPR rules?
The following items:
- user/login For the TOKEN.
- user/database For the DATABASE_ID
- subscriber/findByEmail For the SUBSCRIBER_ID