When creating a crowdsourced database, sometimes an email, web or social media campaign is involved to request that users create or update a profile.
Campaigns may have different goals. Common campaigns include:
Registration Campaigns - Requesting that users join and create a new location
Claim Campaigns - Requesting that users join and claim specific locations
Ideally all campaigns should support all scenarios and provide the appropriate calls to action for end users. It is important to remember that users will commonly not recall whether they have a profile in the locator or not. Invitation emails may have been forwarded, former contacts may no longer be avaiable etc.
Registration Campaigns
The campaign call-to-action link can trigger the User Registration form by including the parameter shown below:
https://yourwebsite.com/locator?ml___ml_trigger_registration=1&utm_source=newsletter&utm_medium=email&utm_campaign=spring2023
The ml___ml_trigger_registration=1 parameter causes the system to:
Immediately open the Registration Form dialog
Open the Crowdsourcing Form after the user completes the Registration Form to an empty form, ready for the user to add a new location.
Claim Campaigns
A claim campaign is used when you have specific locations in MetaLocator which should be updated by specific users. This implies that you can create a dynamically-generated link which requests that a specific user claim and update a specific location.
https://yourwebsite.com/locator?ml___ml_trigger_claim_form=123456789&utm_source=newsletter&utm_medium=email&utm_campaign=spring2023
The ml___ml_trigger_claim_form=nnnn parameter causes the system to:
Immediately open the Registration Form dialog
Open the Crowdsourcing Form after the user completes the Registration Form pre-loaded with the location with ID specified.
The ml___ml_trigger_claim_form parameter can also be passed the value of a configured external key field. This is a helpful shortcut when exporting the location ID and aligning it with an external marketing database is prohibitive. When an external key is provided for this parameter, &ml_trigger_externalkey=1
must also be indicated in the URL. For example:
https://yourwebsite.com/locator?ml___ml_trigger_claim_form=AABBCCDD&ml_trigger_externalkey=1
The ml___ml_trigger_claim_form parameter can also be passed the MD5 hash of the MetaLocator Owner Account's API Key concatenated with the value of a configured external key field, separated by an underscore character. This is a security precaution which prevents URL tampering. For example, if a malicious actor receives an invitation link such as:
https://yourwebsite.com/locator?ml___ml_trigger_claim_form=10
They could easily modify the value to
https://yourwebsite.com/locator?ml___ml_trigger_claim_form=11
And attempt to trick the users managing your approval process into approving their access to the location with ID 11, providing that they also have access to the authentication data requested in your Registration Form. This underscores the importance of requesting private information in the Registration Form.
To avoid this scenario, instead of exposing the location ID, or external key value, the ml___ml_trigger_claim_form parameter can also be set to the MD5 hash of the MetaLocator Owner Account's API Key and the record's external key value, separated by an underscore character.
For example, a record's external key value may be 12345, and the API Key is 11223344556677889900aabbccddee.
The secure value of ml___ml_trigger_claim_form can be calculated as:
MD5('11223344556677889900aabbccddee_12345')
https://yourwebsite.com/locator?ml___ml_trigger_claim_form=bcd0be49d3301c1944fb45b16f80280e&ml_trigger_externalkey=1
This link now drastically reduces a malicious actor's ability to guess other links.
Links to Login
To create a link which directs users to log in and then immediately redirects to a search for only their locations, use this link:
https://yourwebsite.com/locator?ml___ml_trigger_login=1&ml___ml_trigger_my_locations=1
Campaign UTM Parameters
UTM parameters can be included in user-provided campaign links.
https://yourwebsite.com/locator?ml___ml_trigger_registration=1&utm_source=newsletter&utm_medium=email&utm_campaign=spring2023
They will be stored along with the created user if the Registration Form is updated as shown below. UTM Parameter fields are not visible to the end user.
When configuring UTM Parameter fields, be sure to specify a unique custom field to store the data.
The UTM Parameter fields will be stored alongside other Custom Registration Fields in the User Manager.