DisplaySharingPageParamsType

DisplaySharingPageParamsType = { attribution?: AttributionParams | null; link?: string; metadata?: { homepageLink?: string; i18n?: I18nConfig; logo?: string; targetInteraction?: InteractionTypeKey; }; products?: SharingPageProduct[]; }

Defined in: types/rpc/displaySharingPage.ts:35

Parameters to display the sharing page

Properties

attribution?

optional attribution?: AttributionParams | null

Defined in: types/rpc/displaySharingPage.ts:57

Optional attribution overrides for the outbound sharing URL.

When provided (even as an empty object), Frak adds standard affiliation params (utm_source=frak, utm_medium=referral, utm_campaign=<merchantId>, ref=<clientId>, via=frak) alongside fCtx. Existing UTMs on the base URL are preserved (gap-fill). Set this to null to disable attribution params entirely (only fCtx is added).

Default

{} — defaults applied

---

link?

optional link?: string

Defined in: types/rpc/displaySharingPage.ts:45

Optional link override for sharing If not provided, the sharing link will be generated from the current page URL + merchant context

---

metadata?

optional metadata?: { homepageLink?: string; i18n?: I18nConfig; logo?: string; targetInteraction?: InteractionTypeKey; }

Defined in: types/rpc/displaySharingPage.ts:61

Optional metadata overrides for the sharing page

homepageLink?

optional homepageLink?: string

Link to the homepage of the calling website

i18n?

optional i18n?: I18nConfig

i18n overrides for the sharing page

logo?

optional logo?: string

Logo override for the sharing page header

targetInteraction?

optional targetInteraction?: InteractionTypeKey

The target interaction behind this sharing page

---

products?

optional products?: SharingPageProduct[]

Defined in: types/rpc/displaySharingPage.ts:40

Products to showcase on the sharing page If provided, they will be displayed in a product card section