Customise Impact Links with URL parameters

Once you have configured and created a link in the app, URL parameters allow you to add additional context to your Impact Link to streamline the checkout experience. Pre-fill an email address or amount for your customers, track campaigns, and streamline reconciliation with your other systems.

Pre-filling checkout information

Email

Pre-filling emails can be useful if you are doing a mail-merge from a CRM tool or as part of a transactional post-purchase email where you know the email address of your customer.

Here's what an example link with pre-filled email looks like:

https://impact.pledge.io/lnk_fgRj0XOB?email=fred@bloggs.com

Currency amount

Here's what an example link with pre-filled currency amount looks like:

https://impact.pledge.io/lnk_fgRj0XOB?amount_in_currency=50

Offsetting amount

Here's what an example link with pre-filled offsetting amount looks like:

https://impact.pledge.io/lnk_jFdQuFAz?amount_in_kg=100

Emission id

Here's what an example link with pre-filled emission id looks like:

https://impact.pledge.io/lnk_eannyqjW?emission_id=ems_cSVGIPA3

Pre-fill parameters

PARAMETER	DESCRIPTION	SYNTAX
`email`	Use `email` to enter an email address on the checkout page of the Impact Link automatically. Your end customer can still edit this field, so the email you pass in for `email` might not be the same email that your customer uses to complete the purchase.	`email` must be a valid email address. Invalid values are silently dropped and your Impact Link continues to work as expected.
`amount_in_currency`	Use `amount_in_currency` to pre-fill an amount on the checkout page of the Impact Link automatically when the link has been configured as `Order by Value (Currency)` Your end customer can still edit this field, so the amount you pass in for `amount_in_currency` might not be the same amount that your customer uses to complete the purchase.	Must be a valid decimal number. Invalid values are silently dropped and your Impact Link continues to work as expected.
`amount_in_kg`	Use `amount_in_kg` to pre-fill an amount on the checkout page of the Impact Link automatically when the link has been configured as `Order by Weight (Kilograms)` Your end customer can still edit this field, so the amount you pass in for `amount_in_kg` might not be the same amount that your customer uses to complete the purchase.	Must be a valid decimal number. Invalid values are silently dropped and your Impact Link continues to work as expected.
`emission_id`	Use `emission_id` to pre-fill the details and emissions details of an emissions calculation.	Must be a valid emission id retrieved from the Pledge API.

Metadata

You can simplify reconciliation and enrich offsetting orders additional context with metadata URL parameters. You can specify arbitrary metadata fields and values and it will be passed through to the resulting offsetting order.

Here's what an example link with metadata looks like:

https://impact.pledge.io/lnk_fgRj0XOB?metadata[order_id]=a1234&metadata[customer_id]=x9876

Warning: Do not pass any PII as metadata to avoid inadvertently risking any GDPR or data-protection issues

UTM tracking

You can use Urchin Tracking Module (UTM) codes to track how customers found your site when they checkout using your Impact Link. You can add UTM codes as parameters in the query string of your URL. Impact Links support the following UTM codes: utm_source, utm_content, utm_medium, utm_term, and utm_campaign.

Here’s what an example link looks like:

https://impact.pledge.io/lnk_fgRj0XOB?utm_medium=email&utm_source=social&utm_campaign=summer_promo

To use UTM codes, specify a Redirect Link as the confirmation page when configuring the Impact Link. When customers complete a purchase via an Impact Link, your redirect URL contains the UTM code parameters specified in your Impact Link URL.

PARAMETER	DESCRIPTION
`utm_source`	Identifies where the traffic originated (for example, a website name, social media, or a search engine).
`utm_content`	Identifies what content your customer chooses. Use this parameter to distinguish between links that point to the same payment page.
`utm_medium`	Identifies the marketing medium that accesses your Impact Link (for example, email, cost per click (cpc), or other methods).
`utm_term`	Identifies specific search terms and keywords in your paid search ads.
`utm_campaign`	Identifies your marketing campaigns using the Impact Link URL.

Warning: UTM codes can be composed of alphanumeric characters, dashes, or underscores, and be any value up to 150 characters. Invalid values are silently dropped and your Impact Link continues to work as expected.

Carbon offsetting - how it works