Skip to content

ProcessReferralOptions

ProcessReferralOptions = { alwaysAppendUrl?: boolean; merchantId?: string; }

Defined in: actions/referral/processReferral.ts:17

Options for the referral auto-interaction process.

optional alwaysAppendUrl?: boolean

Defined in: actions/referral/processReferral.ts:23

If true, always replace the URL with the current user’s referral context so the next visitor gets referred by this user.

false

optional merchantId?: string

Defined in: actions/referral/processReferral.ts:29

Merchant ID for building the current user’s referral context. Required when alwaysAppendUrl is true and the incoming context is V1. For V2 contexts, the merchantId is already embedded in the context.