---
title: unsubscribe
slug: campaign/docs/unsubscribe
docTags: 
createdAt: 2026-07-02T19:01:46.338Z
---

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).<br />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.<br />**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.<br />Error codes:<br />- 501=wrong authentication tag<br />- 502=wrong request IP<br />- 503=wrong request method<br />- 504=wrong protocol<br />- 505=wrong recipient list<br />- 506=wrong action<br />- 507=action not found<br />If a verification of the authentication tag does not solve the problem, contact *customer support*. |
| missing\_id               | No **bmRecipientId** was set (mandatory) when using the form service.                                                                                                                                                                                                                                                                                          |
| system\_error             | A general error has occurred                                                                                                                                                                                                                                                                                                                                   |

**Example 1**

```javascript
.../form/.../unsubscribe?bmRecipientId=john.smith%40example.com
```

Unsubscribes the recipient with the ID [\_john.smith@example.com\_](#) using the form service.

**Example 2**

```javascript
.../mail/.../unsubscribe?bmRemoveId=true&bmUrl=http://www.example.com
```

Unsubscribes the recipient of the newsletter and removes the recipient from all recipient lists. Then, the recipient is forwarded to [www.example.com](http://www.example.com).