remove
Tip This operation does not unsubscribe a recipient. To do that, use the unsubscribe operation.
This operation is available in the mail and the form service.
Parameters
Name | Mandatory | Default value | Description |
|---|---|---|---|
bmRecipientId | yes/no | – | The ID of the new 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. |
Return values
Value | Description |
|---|---|
ok | Recipient successfully removed from the recipient list |
ok: not_found | Only with bmVerbose=true: The recipient could not be found in the recipient list. |
wrong_tag | Authorization failed. Error codes:
|
missing_id | When using the form service: No bmRecipientId was transmitted. |
system_error | A general error occurred. |
Example 1
.../form/.../remove?bmRecipientId=john.smith%40example.comThe recipient with the ID [email protected]_ is removed from the recipient list. This recipient list is identified by the authorization code.
Example 2
.../mail/.../remove?bmUrl=http://www.example.comThe recipient of the email is removed from the recipient list to which the mailing was sent. Then, the recipient is forwarded to www.example.com.