How to create redemption templates

Create and customize a branded redemption experience for your users and clients. Add your messaging, logo and branding to your emails and the redemption pages. Even if you are sending payouts through your own channels, you can customize the redemption pages.

Create a new template

1. In the main-navigation, click “Customization” and then select “User redemption”

2. To create a new template click “+ New template”

On the next page you can customize the email and landing pages of your redemption experience

a. Give your template a name. This is required in order to save your template.

b. Add a “Sender name”. This will appear as the “From” name in the emails you send via Runa and at the bottom of your landing pages. If you do not add a sender name, the “From” name will display your company name. (If you do not send emails via Runa, your users will not see this email)

c. Upload a logo. This will appear at the top of your email and the landing pages throughout the redemption experience.

d. Choose a “Primary color”. This will edit the button colour throughout the user experience.

e. Choose a “Background color”. This will change the background color that sits behind your email and landing pages.

If you are sending emails through Runa, you can customize how these will look:

1. Open the dropdown called “Email messaging”
2. Add a “Subject line”. By default the subject line is “You've been sent a payout”
3. Add an “Message” that appears in the email body e.g. “Happy birthday! Here’s a gift from us”.
4. Upload a “Banner image”. This will appear in the email body.
5. You can also add a URL to your own “Privacy Policy” which will show in the footer of your emails.
6. Review the previews at the top of the page for the emails and landing pages. When you’re happy, click “Save template” at the bottom of the form.

 

How to add the template to your orders

Order via the Runa Portal

1. Click “Create an order” in the left-hand menu
2. Select whichever order type you want to use
3. In the Redemption template section, select the template you want to use from the dropdown menu.

Order via the API

When you save a new template you will get a unique template ID. You will need this ID to apply to relevant orders sent via the API. We recommend you share this ID with the person responsible for your API integration. If in doubt, speak to a engineer or developer in your company.

1. Copy the template ID. You can get this after saving a template, or by clicking on an existing template in the “User redemption” page.
   
2. Share the ID with the person responsible for your API integration.
3. The ID should be applied to the template_id in the distribution_method of the “Create a new Order” endpoint. If the template is only being used for specific orders, make sure to only apply it to these orders based on how you’ve integrated the Runa API.
4. Your orders will then send with this template applied.
   

We recommend sending a test order to review your emails and landing pages. Currently it is not possible to test customisation using the Runa Playground, so you will need to test with live orders.