HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

These procedures are available in the form and mail service.

On forms or in emails, you can give recipients the option to reject the use of personally identifiable data. If they do, the recipients are not included in action-based target groups (e.g., "has clicked Link B in Mailing A"), even if they meet the conditions of the target group.

Notes on tracking opt-out

  • Opens and clicks are still saved anonymously and included in global reports. The open and clicks in a mailing of such a recipient would therefore be counted. However, the recipient is not taken into account if you create a target group containing all recipients of this mailing who opened or clicked it.

  • All personal action-based data are anonymized from the time of activation. Action data in the recipient history is not retrospectively anonymized.


NameMandatoryDefault valueDescription
bmRecipientIdYes/NoThe recipient ID (usually the email address) <br>This parameter is not required when using the mail service. This parameter is required when using the form service.

**Return values**

ok<ul><li><b>createtrackingoptout</b>. The use of action-based data was deactivated for the recipient.</li>
<li><b>deletetrackingoptout</b>. The use of action-based data was reactivated for the recipient.</li></ul>
vetoedThe execution of this operation was prevented because it is deactivated. Ask [customer support](🔗) to activate this feature.
wrong\_tagAuthorization failed.<br><br>Error codes:<br><ul><li>501=wrong authentication tag</li>

<li>502=wrong request IP</li> <li>503=wrong request method</li> <li>504=wrong protocol</li> <li>505=wrong recipient list</li> <li>506=wrong action</li> <li>507=action not found</li></ul><br>**Note**: If a verification of the authentication tag does not solve the problem, contact [customer support](mailto:[email protected]). | | missing\_id | No **bmRecipientId** was transmitted (mandatory) when using the form service. | | system\_error | A general error has occurred. |

**Example 1**

The use of action-based data has been deactivated for the recipient with ID _[email protected]_.

**Example 2**

The use of action-based data has been reactivated for the recipient with ID _[email protected]_.