{"id":1008,"date":"2026-05-06T17:00:00","date_gmt":"2026-05-06T22:00:00","guid":{"rendered":"https:\/\/tolinku.com\/blog\/?p=1008"},"modified":"2026-03-07T04:46:06","modified_gmt":"2026-03-07T09:46:06","slug":"onboarding-deep-link-parameters","status":"publish","type":"post","link":"https:\/\/tolinku.com\/blog\/onboarding-deep-link-parameters\/","title":{"rendered":"Onboarding Deep Link Parameters: What Data to Pass"},"content":{"rendered":"\n

Deep links that drive app installs carry parameters through the install process via deferred deep linking. These parameters determine what the user sees during onboarding, which steps they skip, and what context personalizes their experience. Choosing the right parameters is the difference between a personalized onboarding and a generic one.<\/p>\n\n\n\n

For personalization strategies, see Personalized Onboarding Flows with Deep Link Data<\/a>. For invite-specific flows, see Invite Link Onboarding: From Invitation to Active User<\/a>. For a broader guide to deep link parameter design, see Deep Link Parameters: A Complete Guide<\/a>.<\/p>\n\n\n\n

Parameter Categories<\/h2>\n\n\n\n

1. Attribution Parameters<\/h3>\n\n\n\n

These identify where the user came from:<\/p>\n\n\n\n

\n\n\n\n\n\n\n\n
Parameter<\/th>\nExample Value<\/th>\nPurpose<\/th>\n<\/tr>\n<\/thead>\n
utm_source<\/code><\/td>\ninstagram<\/code>, google<\/code>, newsletter<\/code><\/td>\nTraffic source<\/td>\n<\/tr>\n
utm_medium<\/code><\/td>\nsocial<\/code>, cpc<\/code>, email<\/code><\/td>\nMarketing channel<\/td>\n<\/tr>\n
utm_campaign<\/code><\/td>\nsummer_sale_2026<\/code><\/td>\nCampaign name<\/td>\n<\/tr>\n
utm_content<\/code><\/td>\nhero_banner_v2<\/code><\/td>\nCreative variant<\/td>\n<\/tr>\n
utm_term<\/code><\/td>\nrunning+shoes<\/code><\/td>\nSearch keyword<\/td>\n<\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n
https:\/\/go.yourapp.com\/signup?utm_source=instagram&utm_medium=social&utm_campaign=summer_sale\n<\/code><\/pre>\n\n\n\n
These parameters don't directly affect onboarding screens, but they're essential for measuring which acquisition channels produce the most engaged users.<\/p>\n\n\n\n
2. Referral Parameters<\/h3>\n\n\n\n
These connect the new user to an existing user:<\/p>\n\n\n\n
\n\n\n\n\n\n\n\n
Parameter<\/th>\nExample Value<\/th>\nPurpose<\/th>\n<\/tr>\n<\/thead>\n
ref<\/code><\/td>\nuser_abc123<\/code><\/td>\nReferrer's user ID<\/td>\n<\/tr>\n
referrer_name<\/code><\/td>\nSarah<\/code><\/td>\nReferrer's display name<\/td>\n<\/tr>\n
referral_code<\/code><\/td>\nSARAH-2026<\/code><\/td>\nHuman-readable referral code<\/td>\n<\/tr>\n
reward<\/code><\/td>\n10<\/code><\/td>\nReward amount<\/td>\n<\/tr>\n
reward_type<\/code><\/td>\ncredit<\/code><\/td>\nReward type (credit, discount, etc.)<\/td>\n<\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n
https:\/\/go.yourapp.com\/refer\/SARAH-2026?ref=user_abc123&referrer_name=Sarah&reward=10\n<\/code><\/pre>\n\n\n\n
3. Content Parameters<\/h3>\n\n\n\n
These point to specific content the user was interested in:<\/p>\n\n\n\n
\n\n\n\n\n\n\n\n
Parameter<\/th>\nExample Value<\/th>\nPurpose<\/th>\n<\/tr>\n<\/thead>\n
product_id<\/code><\/td>\nprod_xyz789<\/code><\/td>\nSpecific product<\/td>\n<\/tr>\n
category<\/code><\/td>\nrunning<\/code><\/td>\nProduct category<\/td>\n<\/tr>\n
content_id<\/code><\/td>\narticle_456<\/code><\/td>\nSpecific article or content piece<\/td>\n<\/tr>\n
content_type<\/code><\/td>\nplaylist<\/code><\/td>\nType of content<\/td>\n<\/tr>\n
collection_id<\/code><\/td>\ncoll_abc<\/code><\/td>\nCollection or list<\/td>\n<\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n
https:\/\/go.yourapp.com\/product\/prod_xyz789?category=running\n<\/code><\/pre>\n\n\n\n
4. Promotional Parameters<\/h3>\n\n\n\n
These carry offer and discount information:<\/p>\n\n\n\n
\n\n\n\n\n\n\n\n
Parameter<\/th>\nExample Value<\/th>\nPurpose<\/th>\n<\/tr>\n<\/thead>\n
promo<\/code><\/td>\nSUMMER50<\/code><\/td>\nPromo code<\/td>\n<\/tr>\n
discount<\/code><\/td>\n20<\/code><\/td>\nDiscount percentage<\/td>\n<\/tr>\n
offer_id<\/code><\/td>\noffer_123<\/code><\/td>\nServer-side offer reference<\/td>\n<\/tr>\n
trial_days<\/code><\/td>\n14<\/code><\/td>\nExtended trial period<\/td>\n<\/tr>\n
plan<\/code><\/td>\npremium<\/code><\/td>\nPre-selected plan<\/td>\n<\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n
https:\/\/go.yourapp.com\/signup?promo=SUMMER50&discount=20&plan=premium\n<\/code><\/pre>\n\n\n\n
5. Context Parameters<\/h3>\n\n\n\n
These provide situational context:<\/p>\n\n\n\n
\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nExample Value<\/th>\nPurpose<\/th>\n<\/tr>\n<\/thead>\n
role<\/code><\/td>\nseller<\/code>, buyer<\/code><\/td>\nUser type for marketplace apps<\/td>\n<\/tr>\n
team_id<\/code><\/td>\nteam_abc<\/code><\/td>\nTeam to join<\/td>\n<\/tr>\n
event_id<\/code><\/td>\nevt_123<\/code><\/td>\nEvent context<\/td>\n<\/tr>\n
partner<\/code><\/td>\nshopify<\/code><\/td>\nPartner integration source<\/td>\n<\/tr>\n
locale<\/code><\/td>\nes_MX<\/code><\/td>\nPreferred language<\/td>\n<\/tr>\n
source_screen<\/code><\/td>\npricing_page<\/code><\/td>\nWhere on your website they clicked<\/td>\n<\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n
https:\/\/go.yourapp.com\/join?team_id=team_abc&role=member&partner=slack\n<\/code><\/pre>\n\n\n\n
What NOT to Put in Parameters<\/h2>\n\n\n\n
Never Include<\/h3>\n\n\n\n
\n\n\n\n\n\n\n\n\n
Data<\/th>\nWhy Not<\/th>\nAlternative<\/th>\n<\/tr>\n<\/thead>\n
Email addresses<\/td>\nPII in URLs, logged everywhere<\/td>\nUse a session token<\/td>\n<\/tr>\n
Passwords<\/td>\nSecurity risk<\/td>\nNever pass credentials in URLs<\/td>\n<\/tr>\n
SSNs, account numbers<\/td>\nRegulatory violation<\/td>\nUse encrypted server-side lookup<\/td>\n<\/tr>\n
Full names<\/td>\nPII concerns<\/td>\nUse first name only or referral code<\/td>\n<\/tr>\n
Phone numbers<\/td>\nPII, regulatory<\/td>\nUse a session token<\/td>\n<\/tr>\n
Payment info<\/td>\nPCI compliance violation<\/td>\nNever expose in URLs<\/td>\n<\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n
Use Tokens Instead<\/h3>\n\n\n\n
For sensitive data, use an opaque token that maps to server-side data:<\/p>\n\n\n\n
\/\/ Bad\nconst link = `https:\/\/go.yourapp.com\/signup?email=jane@example.com&name=Jane+Smith`;\n\n\/\/ Good\nconst sessionToken = await createPreSignupSession({\n  email: 'jane@example.com',\n  name: 'Jane Smith',\n  preferences: { category: 'fitness' },\n});\n\nconst link = `https:\/\/go.yourapp.com\/signup?session=${sessionToken}`;\n<\/code><\/pre>\n\n\n\n
The app fetches the pre-filled data from your server using the token, keeping PII out of the URL.<\/p>\n\n\n\n
Parameter Design Rules<\/h2>\n\n\n\n
1. Keep Parameter Names Short and Consistent<\/h3>\n\n\n\n
\/\/ Good: short, consistent naming\nconst params = {\n  ref: 'user_abc',      \/\/ referrer\n  src: 'instagram',      \/\/ source (alias for utm_source)\n  cat: 'running',        \/\/ category\n  pid: 'prod_xyz',       \/\/ product ID\n  promo: 'SUMMER50',     \/\/ promo code\n};\n\n\/\/ Bad: verbose, inconsistent\nconst params = {\n  referrer_user_id: 'user_abc',\n  trafficSource: 'instagram',\n  product_category: 'running',\n  productId: 'prod_xyz',\n  promotional_code: 'SUMMER50',\n};\n<\/code><\/pre>\n\n\n\n
Short parameter names reduce URL length (important for SMS and social sharing where character limits exist).<\/p>\n\n\n\n
2. Use IDs, Not Names<\/h3>\n\n\n\n
\/\/ Good: IDs are stable\nconst link = `https:\/\/go.yourapp.com\/refer?ref=user_abc123`;\n\n\/\/ Bad: names can change and have encoding issues\nconst link = `https:\/\/go.yourapp.com\/refer?referrer_name=Mar\u00eda%20Garc\u00eda`;\n<\/code><\/pre>\n\n\n\n
Look up names server-side using the ID.<\/p>\n\n\n\n
3. Validate All Parameters on Receipt<\/h3>\n\n\n\n
async function processDeepLinkParams(params) {\n  const validated = {};\n\n  \/\/ Validate referrer exists\n  if (params.ref) {\n    const referrer = await getUser(params.ref);\n    if (referrer) {\n      validated.referrer = referrer;\n    }\n  }\n\n  \/\/ Validate product exists\n  if (params.pid) {\n    const product = await getProduct(params.pid);\n    if (product && product.isActive) {\n      validated.product = product;\n    }\n  }\n\n  \/\/ Validate promo code\n  if (params.promo) {\n    const promo = await validatePromoCode(params.promo);\n    if (promo && promo.isActive) {\n      validated.promo = promo;\n    }\n  }\n\n  \/\/ Sanitize string params\n  if (params.referrer_name) {\n    validated.referrerName = sanitize(params.referrer_name);\n  }\n\n  return validated;\n}\n<\/code><\/pre>\n\n\n\n
4. Set Defaults for Missing Parameters<\/h3>\n\n\n\n
function getOnboardingConfig(params) {\n  return {\n    source: params.utm_source || 'organic',\n    campaign: params.utm_campaign || null,\n    referrer: params.ref || null,\n    product: params.pid || null,\n    promoCode: params.promo || null,\n    role: params.role || 'buyer', \/\/ Default role\n    locale: params.locale || getDeviceLocale(),\n    flow: params.ref ? 'referral' : params.pid ? 'product' : 'default',\n  };\n}\n<\/code><\/pre>\n\n\n\n
Parameter Combinations<\/h2>\n\n\n\n
Common Link Templates<\/h3>\n\n\n\n
const linkTemplates = {\n  referral: {\n    path: '\/refer\/{code}',\n    requiredParams: ['ref', 'referrer_name'],\n    optionalParams: ['reward', 'reward_type'],\n    example: '\/refer\/SARAH-2026?ref=user_abc&referrer_name=Sarah&reward=10',\n  },\n\n  productAd: {\n    path: '\/product\/{id}',\n    requiredParams: ['utm_source', 'utm_campaign'],\n    optionalParams: ['promo', 'category'],\n    example: '\/product\/prod_xyz?utm_source=facebook&utm_campaign=summer_sale&promo=SUMMER50',\n  },\n\n  teamInvite: {\n    path: '\/join\/{team_id}',\n    requiredParams: ['team_id', 'role'],\n    optionalParams: ['inviter_name', 'inviter_id'],\n    example: '\/join\/team_abc?role=member&inviter_name=Alex',\n  },\n\n  contentShare: {\n    path: '\/share\/{type}\/{id}',\n    requiredParams: ['content_type', 'content_id'],\n    optionalParams: ['sharer_name', 'ref'],\n    example: '\/share\/playlist\/pl_123?sharer_name=Mike&ref=user_def',\n  },\n};\n<\/code><\/pre>\n\n\n\n
How Parameters Map to Onboarding Steps<\/h3>\n\n\n\n
For a complete guide to using these parameters for contextual routing, see Contextual Deep Linking Guide<\/a>.<\/p>\n\n\n\n
\n\n\n\n\n\n\n\n\n
Parameters Present<\/th>\nOnboarding Effect<\/th>\n<\/tr>\n<\/thead>\n
ref<\/code> + referrer_name<\/code><\/td>\nShow referral welcome, acknowledge referrer<\/td>\n<\/tr>\n
pid<\/code> + category<\/code><\/td>\nSkip category selection, show product first<\/td>\n<\/tr>\n
promo<\/code> + discount<\/code><\/td>\nShow promo banner, pre-apply discount<\/td>\n<\/tr>\n
team_id<\/code> + role<\/code><\/td>\nSkip role selection, auto-join team<\/td>\n<\/tr>\n
utm_source=ad<\/code> + utm_campaign<\/code><\/td>\nShow campaign-specific landing<\/td>\n<\/tr>\n
None (organic)<\/td>\nFull standard onboarding<\/td>\n<\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n
Debugging Parameters<\/h2>\n\n\n\n
Logging<\/h3>\n\n\n\n
Log parameters on receipt for debugging (but sanitize sensitive data):<\/p>\n\n\n\n
function logDeepLinkParams(params) {\n  const sanitized = { ...params };\n\n  \/\/ Mask any potential PII\n  if (sanitized.email) sanitized.email = '***@***.***';\n  if (sanitized.session) sanitized.session = sanitized.session.slice(0, 8) + '...';\n\n  console.log('Deep link params received:', sanitized);\n\n  analytics.track('deep_link_params_received', {\n    paramCount: Object.keys(params).length,\n    hasReferral: params.ref ? true : false,\n    hasProduct: params.pid ? true : false,\n    hasPromo: params.promo ? true : false,\n    source: params.utm_source || 'none',\n  });\n}\n<\/code><\/pre>\n\n\n\n
Testing Parameter Flows<\/h3>\n\n\n\n
Create test links with different parameter combinations and verify each onboarding path:<\/p>\n\n\n\n
const testLinks = [\n  { name: 'Referral', url: 'https:\/\/go.yourapp.com\/refer\/TEST?ref=test_user&referrer_name=Test' },\n  { name: 'Product', url: 'https:\/\/go.yourapp.com\/product\/test_prod?category=test' },\n  { name: 'Campaign', url: 'https:\/\/go.yourapp.com\/signup?utm_source=test&utm_campaign=test_campaign' },\n  { name: 'Team invite', url: 'https:\/\/go.yourapp.com\/join\/test_team?role=member' },\n  { name: 'Organic', url: 'https:\/\/go.yourapp.com\/' },\n];\n<\/code><\/pre>\n\n\n\n
For dynamic routes, see the dynamic routes documentation<\/a>. For deep linking features, see Tolinku deep linking<\/a>. For onboarding use cases, see the onboarding documentation<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
Learn which parameters to include in onboarding deep links. Pass referral codes, campaign data, product IDs, and user preferences through the install process.<\/p>\n","protected":false},"author":2,"featured_media":1007,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"rank_math_title":"Onboarding Deep Link Parameters: What Data to Pass","rank_math_description":"Learn which parameters to include in onboarding deep links. Pass referral codes, campaign data, product IDs, and user preferences through the install process.","rank_math_focus_keyword":"onboarding deep link parameters","rank_math_canonical_url":"","rank_math_facebook_title":"","rank_math_facebook_description":"","rank_math_facebook_image":"https:\/\/tolinku.com\/blog\/wp-content\/uploads\/2026\/03\/og-onboarding-deep-link-parameters.png","rank_math_facebook_image_id":"","rank_math_twitter_title":"","rank_math_twitter_description":"","rank_math_twitter_image":"https:\/\/tolinku.com\/blog\/wp-content\/uploads\/2026\/03\/og-onboarding-deep-link-parameters.png","footnotes":""},"categories":[18],"tags":[20,21,69,27,236,43,26,50],"class_list":["post-1008","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-use-cases","tag-deep-linking","tag-deferred-deep-linking","tag-mobile-development","tag-onboarding","tag-parameters","tag-personalization","tag-user-acquisition","tag-utm-parameters"],"_links":{"self":[{"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/posts\/1008","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/comments?post=1008"}],"version-history":[{"count":4,"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/posts\/1008\/revisions"}],"predecessor-version":[{"id":2823,"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/posts\/1008\/revisions\/2823"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/media\/1007"}],"wp:attachment":[{"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/media?parent=1008"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/categories?post=1008"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/tolinku.com\/blog\/wp-json\/wp\/v2\/tags?post=1008"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}