How to use Voucher Reservations? (deprecated)

This feature has been deprecated and is now replaced by User Segments Reservations since v3.1.0

The documented APIs remain for backward compatibility: any attempt to generate reservations for a voucher will actually generate reservations on the user segment associated with that voucher, assuming the user segment requires reservations. Any vouchers that were defined as reserved prior to v3.1.0 were automatically upgraded to have a new user segment, named as their TRC, containing all their user ID reservations, so redemption functionality for those vouchers did not change.


Before v3.1.0:

Voucher Reservations allow limiting a voucher to particular custom player IDs or device IDs. It's a great way to offer exclusive vouchers during retargeting and pre-registration campaigns, without worrying about those users sharing their voucher download/deep links with others.

Enabling Reservations

Vouchers are not reserved by default. In order to set a voucher as reserved, first go to its Settings page, set it to "Reserved" and click "Save Changes":

Setting Reserved User IDs

Note: updating reserved IDs for a voucher that is not set as "Reserved" will have no impact - the reserved IDs will be included in the voucher, however, they will be ignored during redemption. Make sure you enable reservations for the voucher in order for the reserved IDs to take effect

You have several ways of actually specifying custom reserved IDs for each voucher:

  • Use your own predefined list of IDs:
    When you have a large set of IDs that you wish to be reserved, contact your TROPHiT account manager with a file, containing all IDs (one per line) and request it to be reserved for a particular voucher. A self-service version is coming soon...
  • Automatically generate IDs by TROPHiT:
    When you wish to generate a small number of IDs at a time, for example, one ID upon every user signup, use our Management API to auto-generate a reservation with a unique ID and store it on your system. The API uses HTTP Basic Authentication - use your account's API key and secret as the user/password, respectively.

    The following example generates and reserves a new single unique ID for voucher 215:

    The response is a JSON in the format:

    The following example generates and reserves a new single unique ID for voucher 215, already inside the given URL-encoded tracking link template:{trophit.userid}%26deep_link%3Dmyapp%253A%252F%252F%253Ftrc%253D{trophit.trc}%2526label%253D{trophit.userid}%22

    The response is a JSON in the format:


    • Always check the result array is not empty. It might be empty if you exceeded the number of allowed reservations or there was a problem generating the ID
    • You may only reserve up to a total of 1,000,000 IDs per voucher
    • You may only generate up to 200 IDs per API call (i.e. &count=200)

Distributing Reserved Vouchers

Finally, to use your reservations, place each unique ID on the tracking link delivered to your users, in one of the vacant parameters like &label (Adjust), &af_sub5 (AppsFlyer), &pub5 (Tune) and more, as well as inside your deeplink URLs. For example:



Please sign in to leave a comment.
Powered by Zendesk