Guides

User invite

Suggest Edits

User invite

1. setAppInviteOneLinkID(oneLinkID, callback)

Set the OneLink ID that should be used for User-Invite-API.
The link that is generated for the user invite will use this OneLink ID as the base link ID.

parametertypedescription
oneLinkIDstringoneLinkID
callbackfunctionsuccess callback

📘

Note

  • Make sure to call setAppInviteOneLinkID() before calling start.
  • The OneLink template must be assigned to the app.
2. generateInviteLink(parameters, success, error)

A complete list of supported parameters is available here. Custom parameters can be passed using a userParams{} nested object, as in the example above.

parametertypedescription
parametersjsonparameters for Invite link
successfunctionsuccess callback (generated link)
errorfunctionerror callback

Example:


// set the template ID before you generate a link. Without it UserInvite won't work.
appsFlyer.setAppInviteOneLinkID('scVs', null);

// set the user invite params
appsFlyer.generateInviteLink(
 {
   channel: 'gmail',
   campaign: 'myCampaign',
   customerID: '1234',
   userParams: {
     deep_link_value : 'value', // deep link param
     deep_link_sub1 : 'sub1', // deep link param
     custom_param : 'custom',
     brandDomain:'myexample.com'
   },
 },
 (link) => {
   console.log(link);
 },
 (err) => {
   console.log(err);
 }
);

Updated 3 months ago