Home / Subscriber / forgetArchivedSubscriber

Subscriber ‐ forgetArchivedSubscriber


Description:

forget a archived 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.
- Forgetting the archived subscriber has failed
- The selected archived subscriber is already forgotten
- he selected archived subscriber does not exist

Example:

You should call this function as followed:
- rest/v2/subscriber/forgetArchivedSubscriber?token=TOKEN&database=DATABASE_ID&id=SUBSCRIBER_ARCHIVE_ID

                require_once 'Rest.php';

                $username = 'my_username';
                $password = 'my_password';
                $database = '999';

                $rest = new Rest($username, $password, $database);
                $result = $rest->call('subscriber/forgetArchivedSubscriber', [
                	'id' => 'SUBSCRIBER_ARCHIVE_ID'
                ], 'GET');

                var_dump($result);
            

Parameters:

The following parameters this method can/should be called with:

key: id
values: integer, required
what: The ID of the archived subscriber

See:

The following items:
- user/login For the TOKEN.
- user/database For the DATABASE_ID
- subscriber/findArchivedByEmail For the SUBSCRIBER_ARCHIVE_ID