HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

A **mail ID** identifies a single mail that has been sent to a single recipient. It is the aggregation of these three IDs: **mailing ID**, **recipient list ID** and **recipient ID**. The **mail ID** can be appended to a tracked link.

getMailingIdQueries the mailing ID.
getMandatorIdQueries the client's ID.
getRecipientIdQueries the ID of a recipient that received a mail.
getRecipientListIdQueries the ID of the recipient list a recipient belongs to.

## Using mail IDs

To include the **mail ID** into a tracking link, use the special field function **{bmMailId}**.


Within **mypage.php**, the parameter **myId** contains the mail ID.