unsubscribe
By default, unsubscribed recipients are not deleted from the list, but marked as unsubscribed.
This operation is available in the mail and the form services.
Parameters
Name | Mandatory | Default value | Description |
|---|---|---|---|
bmRecipientId | yes/no | – | The ID of the recipient (usually the email address). If used in the mail service, this parameter is not mandatory (the email address is sent anyway). If used in the form service, the parameter is mandatory. |
bmMailId | no | – | This ID identifies the recipient to be unsubscribed and the received email. If not transmitted in the form service, the unsubscription is valid, but cannot be assigned to a specific mailing. |
bmRemoveId | no | false | If set to true, the recipient is removed from all recipient lists. Note: Recipients contained in test recipient lists and transaction recipient lists cannot be deleted with this parameter. |
Return values
Value | Description |
|---|---|
ok | Recipient successfully unsubscribed from recipient list |
ok: not_found | Only with bmVerbose=true and bmRemoveId=true: The recipient to be removed was not found in any recipient list. |
ok: already_unsubscribed | Only with bmVerbose=true: Recipient is already unsubscribed. In this case, the recipient cannot be removed from the recipient list. |
wrong_tag | Authorization failed. Error codes:
|
missing_id | No bmRecipientId was set (mandatory) when using the form service. |
system_error | A general error has occurred |
Example 1
.../form/.../unsubscribe?bmRecipientId=john.smith%40example.comUnsubscribes the recipient with the ID [email protected]_ using the form service.
Example 2
.../mail/.../unsubscribe?bmRemoveId=true&bmUrl=http://www.example.comUnsubscribes the recipient of the newsletter and removes the recipient from all recipient lists. Then, the recipient is forwarded to www.example.com.