How to pass user data through URL parameters Follow
Easypromos offers the option of transferring parameters from the incoming URL to data of the participating user. This way, the promotion administrator has access to a feature that allows adding identifying fields to the participants from the reference URL they used to access the promotion.
A practical example:
A brand sends a newsletter to their subscribers with the link to a survey. All users that respond to the survey will enter a prize draw. In this case, the brand will add a parameter to the survey link that identifies each user. The user will receive the newsletter and click on the link. When the users have responded to the survey, they don't need to identify by registering in the entry form, because Easypromos will read the identifying parameters in the URL and add this information to the participating user.
Note: The feature of passing URL parameters is only available in White Label version.
There are two types of parameters that can be passed through URL:
1. Predefined parameters: 3 parameters that are default fields in the entry form and therefore always present in the platform, they allow passing the name, last name, and the email address of the user.
2. Customized parameters: These are fields that the promotion organizer defines.
1. Predefined parameters
There are 3 predefined parameters:
- fn: First Name
- ln: Last Name
- em: Email
These parameters should be added to the URL of the promotion. If the platform detects these parameters, they will be saved in a cookie during the user's session in the promotion, and if the user ends up registering the parameters will be saved as name, last name and email of the user.
It's not necessary to use all 3 parameters, you can use all 3, 2, or just 1.
If the entry form of the promotion is enabled, the Name, Last name, and Email fields will be prefilled with the values the URL passes.
2. Customized parameters
These are parameters that the promotion organizer defines. From the control panel of the promotion, the organizer can indicate which parameters the promotion accepts (apart from the predefined parameters).
Characteristics of the feature of passing customized parameters through URL
- You can add as many parameters as you wish per URL. Each parameter will become an attribute of the participant.
- The parameters can be a unique value. This means, that if this option is enabled, the system will control that there's no other user registered previously with the same value.
- It's possible to add validation rules to the parameters. Only those that have the values in the URL that pass the validation rules will be able to participate.
- The parameters can be optional.
- The user attributes that are passed as a parameter can be used to filter the participants in the admin panel of the promotion. Ie. search for the user with external reference XXX, or segment all the users with parameter values YYY.
- The user attributes that are passed as a parameter can be used to give additional entries in the draw. For example, give additional entries to all participants that have the parameter VIP = 1.
- The user attributes that are passed as a parameter are available in the participant list downloaded as CSV file and in the exportation of participants via REST API.
How to create a user field through a URL parameter
1. Go to the Editor > Entry form > Fields.
2. Add a new element of the type: "Hidden field via URL parameter".
3. Configure the options:
- Short title: The name of the attribute. This is the name of this field that you will see in the participant list.
- Hidden field via URL parameter: This is the exact name of the GET parameter that you will pass via the URL. Easypromos will review that there is a parameter in the URL accessing the promotion with exactly this name.
- Method of validation: Enable this is you want the value to be one-time use only, or you want to set validation rules by a regular expression.
- Is this field mandatory?: Check this option if this parameter is mandatory for the user to be able to enter.
In this example, the brand wants to register participants with the member ID from their community and they also want to register if a user is a VIP member or not, because the VIP members will get an additional entry in the prize draw.
To do this, the brand has created a sweepstakes with entry form and has added two Hidden fields via URL parameter:
The field 'member_id' should be a 6-digit number that can only be used by one participant.
If the URL of the promotion is: https://a.cstmapp.com/p/33129 the brand should send the following link to member no. 789001 who is a VIP member:
The user will see the URL in the address bar like this:
Note: The organizer of the promotion needs to program the URL with the dynamic parameters from their own system in accordance with the parameters of the fields created in the entry form.
If the user signs up, the organizer will see the following in the participant list:
Additionally, the administrator can filter the participant list to see, for example, which VIP members have signed up, and apply bulk actions to a specific user segment:
Can I use this feature if my promotion is embedded as a widget?
Yes, it's possible to use this feature in promotions that are embedded in a website, etc. with the widget of the promotion, the pop-up widget or the link widget. It works just like without the widget. In the widget code, there's an iframe element, and in that iframe, there's the 'src' attribute which is where the URL that loads the widget is. You have to add the parameters to this URL in the iframe of the widget.
Please sign in to leave a comment.